AuthorizationPayment
POST/v1/authorization/payment
Create a authorization payment
Request
- application/json
Body
required
Array [
Array [
]
Array [
]
]
The id of the auth.
payer
object
The email address of the payer.
non-empty
payer_id payer id in merchant
name
object
The prefix, or title, to the party's name.
When the party is a person, the party's given, or first, name.
When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.
When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.
The suffix for the party's name.
When the party is a person, the party's full name.
The ip address of the payer.
[Ecommerce, ContAuth]
trusted payer tag
[MERCHANT, MIDAS]
kind of payer. MidasPay should query or bind the card to merchant's user when payer_type is MERCHANT. MidasPay should query or bind the card to midas user when payer_type is MIDAS.
[UNKNOWN, FEMALE, MALE]
gender of payer.
Value must match regular expression ^\+?\d{5,20}$
The telephone number of the payer.
billing_address
object
Address of payer or payee
country (eg. CN) -- use region_code instead
<= 100 characters
ISO 3166-2 define
city
county
region code
street name
house info
<= 100 characters
address postal code
payer_address
object
Address of payer or payee
country (eg. CN) -- use region_code instead
<= 100 characters
ISO 3166-2 define
city
county
region code
street name
house info
<= 100 characters
address postal code
Value must match regular expression ^[a-zA-Z][a-zA-Z0-9_ ()-]{3,63}$
The text to be shown on the shopper's bank statement.We recommend sending a maximum of 22 characters, otherwise banks might truncate the string
payer login id
midas login id(muid), Apply only to midasbuy.
midas login id type, Apply only to midasbuy.
midas login id country, Apply only to midasbuy.
midas login id register time, Apply only to midasbuy.
additional payment info of channel, collected by checkout page.
The anonymous indicates whether the payer is anonymous (i.e., not authenticated). If true, the card binding information of the payer cannot be queried.
purchase_units
object[]
>= 1
An array of purchase units. Each purchase unit establishes a contract between a payer and the payee. Each purchase unit represents either a full or partial order that the payer intends to purchase from the payee.
The API caller-provided external ID for the order unit. Required for multiple order units when you must update the order through PATCH.
amount
object
The three-character ISO-4217 currency code that identifies the currency.see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
The value as the summary of all kinds of total_amount in breakdown, which might be:An integer for currencies like JPY that are not typically fractional.A decimal fraction for currencies like TND that are subdivided into thousandths.For the required number of decimal places for a currency code, see Currency Codes.
breakdown
object
tax_total
object
The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
The value, which might be: An integer for currencies like JPY that are not typically fractional. A decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency Codes.
taxes
object[]
The tax with breakdown
[UNKNOWN, ECOMMERCE_CONSUMPTION_TAX]
tax type
non-empty
tax name
Tax as a percentage of total amount example: value 8 means the tax as a percentage of total amount is 8%
tax_amount
object
The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
The value, which might be: An integer for currencies like JPY that are not typically fractional. A decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency Codes.
tax reference
item_total
object
The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
The value, which might be: An integer for currencies like JPY that are not typically fractional. A decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency Codes.
[UNKNOWN, TOTAL_AMOUNT, ITEM_AMOUNT]
Tax check mode, check tax by total amount or item amount. If merchant use payment_method=CHECKOUT_PAGE, this field is optional, and no need present tax_check_mode, tax_total of breakdown, taxes of breakdown. Otherwise, this field is required, and merchant should present tax_check_mode, tax_total of breakdown, taxes of breakdown.
[UNKNOWN, TAX_INCLUSIVE, TAX_EXCLUSIVE, NOT_TAX, TAX_DELAY]
tax mode This field is provided by system, merchant should not set it.
discount_display
object
The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
The value, which might be: An integer for currencies like JPY that are not typically fractional. A decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency Codes.
remaining_discount_display
object
The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
The value, which might be: An integer for currencies like JPY that are not typically fractional. A decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency Codes.
before_discount_display
object
The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
The value, which might be: An integer for currencies like JPY that are not typically fractional. A decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency Codes.
payee
object
non-empty and <= 64 characters
The id of merchant or sub_merchant
The email address of merchant.
<= 1000 characters
The purchase description.
items
object[]
The purchase items.
The item id.
The item name.
The item description.
The purchase reference
Capture delay hours
external_amount
object
discount_amount
object
The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
The value, which might be: An integer for currencies like JPY that are not typically fractional. A decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency Codes.
non-empty
The discount reference
fx_amount
object
The FX amount
after_fx_amount
object
The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
The value, which might be: An integer for currencies like JPY that are not typically fractional. A decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency Codes.
extend
object
The extend additional information.
Outside reference number
application_context
object
payment_method
object
The method of payment, such as PAYPAL,CREDIT_CARD,GO_PAY pay etc.
[UNKNOWN, CHECKOUT_PAGE, CREDIT_CARD, GO_PAY, PAYPAL, RAZER_GOLD_PIN_VOUCHER, RAZER_GOLD_WALLET, GCASH, TOUCH_N_GO_EWALLET, BOOST_EWALLET, SHOPEE_PAY_EWALLET, GRABPAY_EWALLET, LINKAJA_EWALLET, DANA_EWALLET, OVO_EWALLET, ...]
The name of pay method, such as PAYPAL,CREDIT_CARD,GO_PAY
[UNKNOWN, CHECKOUT_PAGE, CREDIT_CARD, GO_PAY, PAYPAL, RAZER_GOLD_PIN_VOUCHER, RAZER_GOLD_WALLET, GCASH, TOUCH_N_GO_EWALLET, BOOST_EWALLET, SHOPEE_PAY_EWALLET, GRABPAY_EWALLET, LINKAJA_EWALLET, DANA_EWALLET, OVO_EWALLET, ...]
payment_info
object
wechat_pay_payment_info
object
wechat pay contract template id
wechat pay contract session id, returns when contract responds.
wechat pay mcc code, used when request authorization payment.
Value must match regular expression ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$
specify the expiration time, after which the contract will no longer be allowed
wechat pay authorization code, used to acquire access_token, openid, etc.
checkout_page_payment_info
object
[REDIRECT, EMBED, POPUP]
specify how to integrate the checkout page in your end.
applepay_payment_info
object
[UNKNOWN, NATIVE, REDIRECT]
ewallet card payment type, used to specify the type of ewallet card payment.
card_info
object
The card bin of the card no.
The hash of the card no.
The mask of the card, it shows the first six and last four digits of the card.
The expire of month.
The expire of year.
The card verification value.
funding source name
The name of card holder.
card issuing country
card brand
card cooperation brand
card score, a larger value indicates a higher priority
visa、mc、amex、jcb、Discover : scheme; mada_card:mada_card ..
card number md5
The card verification value.
the selected brand for co-brand.
card contract id, used for card contract payment, if store_recurring_payment_method is true, this field will returned by payments rsp.
mpi_data
object
token authentication verification value
network token
token expiry month
token expiry year
token tokenbrand
The URL where the customer is redirected after the customer approves the payment.
The URL where the customer is redirected after the customer cancels the payment.
The URL where the merchant receive the order event after the order updated.
The URL where the customer is redirected if they choose to skip the payment page.
<= 11 characters
The BCP 47 language tag (RFC 5646) that identifies the language and locale. Format: language[-script][-region] Region can be either ISO 3166-1 alpha-2 (2 letters) or UN M.49 (3 digits) Examples: - "en" (English, United States) - "zh-Hans" (Chinese, Simplified, China) - "zh-Hant" (Chinese, Traditional) - "zh-TW" (Chinese, Traditional, Taiwan) - "zh-HK" (Chinese, Traditional, Hong Kong) - "ja" or "ja-JP" (Japanese, Japan) - "ko" or "ko-KR" (Korean, Korea) - "es-419" (Spanish, Latin America) - "en-001" (English, World) - "pt-BR" (Portuguese, Brazil) see: https://en.wikipedia.org/wiki/IETF_language_tag see: https://datatracker.ietf.org/doc/html/rfc5646
Value must match regular expression ^[A-Z]{2}$
The two-character ISO 3166-1:2006 region code see: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 The region code of the merchant
browser_info
object
browser info
The accept header value of the shopper's browser.
accept 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.
java support tag
javaScript support tag
IETF BCP 47 language code
screen height
screen width
The difference between UTC time and local time, unit: minute.
argument of user browser agent.
auto redirect to merchant,no user clicks. It can also be set in the merchant's global behavior configuration.
The merchant category code. a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. see: https://en.wikipedia.org/wiki/Merchant_category_code
whether to hide order info in checkout page, for CHECKOUT_PAGE payment method.
[UNKNOWN, WEB, H5, APP]
The front-end type in which the user is located.
merchant id to query contractrequested(in header) merchant_id will be used if this field is empty
<= 64 characters
The id of merchant. If empty, defaults to the merchant_id of the signature authentication
[DEFAULT, SUBSCRIPTION_PAYMENT]
The source of the payment.
metadata
object
Extended field
Responses
- 200
- default
OK
- application/json
- Response
- Example
Response
Array [
Array [
]
Array [
]
]
Array [
]
Array [
]
Value must match regular expression ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$
The date and time when the transaction occurred, in Internet date and time format. see: https://datatracker.ietf.org/doc/html/rfc3339#section-5.6
Value must match regular expression ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$
The date and time when the transaction was last updated, in Internet date and time format see: https://datatracker.ietf.org/doc/html/rfc3339#section-5.6
The ID of the order.
The id of the channel order.
[UNKNOWN, CREATED, SAVED, APPROVED, VOIDED, COMPLETED, PAYER_ACTION_REQUIRED, REFUNDING, REFUNDED, CAPTURE_REQUIRED, CAPTURE_FAILED, REFUND_REVERSED, CHARGEBACK, CHARGEBACK_REVERSED, SECOND_CHARGEBACK, ...]
The order status.
purchase_units
object[]
An array of purchase units. Each purchase unit establishes a contract between a payer and the payee. Each purchase unit represents either a full or partial order that the payer intends to purchase from the payee.
The API caller-provided external ID for the order unit. Required for multiple order units when you must update the order through PATCH.
amount
object
The three-character ISO-4217 currency code that identifies the currency.see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
The value as the summary of all kinds of total_amount in breakdown, which might be:An integer for currencies like JPY that are not typically fractional.A decimal fraction for currencies like TND that are subdivided into thousandths.For the required number of decimal places for a currency code, see Currency Codes.
breakdown
object
tax_total
object
The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
The value, which might be: An integer for currencies like JPY that are not typically fractional. A decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency Codes.
taxes
object[]
The tax with breakdown
[UNKNOWN, ECOMMERCE_CONSUMPTION_TAX]
tax type
non-empty
tax name
Tax as a percentage of total amount example: value 8 means the tax as a percentage of total amount is 8%
tax_amount
object
The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
The value, which might be: An integer for currencies like JPY that are not typically fractional. A decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency Codes.
tax reference
item_total
object
The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
The value, which might be: An integer for currencies like JPY that are not typically fractional. A decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency Codes.
[UNKNOWN, TOTAL_AMOUNT, ITEM_AMOUNT]
Tax check mode, check tax by total amount or item amount. If merchant use payment_method=CHECKOUT_PAGE, this field is optional, and no need present tax_check_mode, tax_total of breakdown, taxes of breakdown. Otherwise, this field is required, and merchant should present tax_check_mode, tax_total of breakdown, taxes of breakdown.
[UNKNOWN, TAX_INCLUSIVE, TAX_EXCLUSIVE, NOT_TAX, TAX_DELAY]
tax mode This field is provided by system, merchant should not set it.
discount_display
object
The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
The value, which might be: An integer for currencies like JPY that are not typically fractional. A decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency Codes.
remaining_discount_display
object
The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
The value, which might be: An integer for currencies like JPY that are not typically fractional. A decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency Codes.
before_discount_display
object
The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
The value, which might be: An integer for currencies like JPY that are not typically fractional. A decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency Codes.
payee
object
non-empty and <= 64 characters
The id of merchant or sub_merchant
The email address of merchant.
<= 1000 characters
The purchase description.
items
object[]
The purchase items.
The item id.
The item name.
The item description.
The purchase reference
Capture delay hours
external_amount
object
discount_amount
object
The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
The value, which might be: An integer for currencies like JPY that are not typically fractional. A decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency Codes.
non-empty
The discount reference
fx_amount
object
The FX amount
after_fx_amount
object
The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
The value, which might be: An integer for currencies like JPY that are not typically fractional. A decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency Codes.
extend
object
The extend additional information.
card_info
object
The card bin of the card no.
The hash of the card no.
The mask of the card, it shows the first six and last four digits of the card.
The expire of month.
The expire of year.
The card verification value.
funding source name
The name of card holder.
card issuing country
card brand
card cooperation brand
card score, a larger value indicates a higher priority
visa、mc、amex、jcb、Discover : scheme; mada_card:mada_card ..
card number md5
The card verification value.
the selected brand for co-brand.
card contract id, used for card contract payment, if store_recurring_payment_method is true, this field will returned by payments rsp.
internal_merchant_addition_data
object
内部商户特有字段
The channel name.
[MODE_UNKNOWN, NEED_CONTRACT, NO_CONTRACT, MIX_CONTRACT]
[MODE_UNKNOWN, NEED_CONTRACT, NO_CONTRACT]
payer_address
object
Address of payer or payee
country (eg. CN) -- use region_code instead
<= 100 characters
ISO 3166-2 define
city
county
region code
street name
house info
<= 100 characters
address postal code
internal_transaction_trace_infos
object[]
channel_addition_datas
object[]
外部渠道附加信息。
The channel name.
[MODE_UNKNOWN, NEED_CONTRACT, NO_CONTRACT]
metadata
object
The addition data
{
"create_time": "string",
"update_time": "string",
"id": "string",
"channel_order_id": "string",
"status": "UNKNOWN",
"purchase_units": [
{
"reference_id": "string",
"amount": {
"currency_code": "string",
"value": "string",
"breakdown": {
"tax_total": {
"currency_code": "string",
"value": "string"
},
"taxes": [
{
"tax_type": "UNKNOWN",
"tax_name": "string",
"tax_rate": "string",
"tax_amount": {
"currency_code": "string",
"value": "string"
}
}
],
"tax_reference": "string",
"item_total": {
"currency_code": "string",
"value": "string"
}
},
"tax_check_mode": "UNKNOWN",
"tax_mode": "UNKNOWN",
"discount_display": {
"currency_code": "string",
"value": "string"
},
"remaining_discount_display": {
"currency_code": "string",
"value": "string"
},
"before_discount_display": {
"currency_code": "string",
"value": "string"
}
},
"payee": {
"merchant_id": "string",
"email_address": "user@example.com"
},
"description": "string",
"items": [
{
"id": "string",
"name": "string",
"description": "string"
}
],
"purchase_reference": "string",
"capture_delay_hours": "string",
"external_amount": {
"discount_amount": {
"currency_code": "string",
"value": "string"
},
"discount_reference": "string"
},
"fx_amount": {
"after_fx_amount": {
"currency_code": "string",
"value": "string"
}
},
"extend": {}
}
],
"card_info": {
"card_bin": "string",
"card_hash": "string",
"card_mask": "string",
"expiry_month": "string",
"expiry_year": "string",
"cvc": "string",
"funding_source": "string",
"holder_name": "string",
"card_issuing_country": "string",
"card_brand": "string",
"card_cooperation_brand": "string",
"score": "string",
"card_type": "string",
"card_md5": "string",
"card_pwd": "string",
"selected_brand": "string",
"card_contract_id": "string"
},
"internal_merchant_addition_data": {
"channel_name": "string",
"merchant_contract_mode": "MODE_UNKNOWN",
"channel_contract_mode": "MODE_UNKNOWN",
"channel_account_id": "string",
"channel_real_channels": [
"string"
],
"channel_order_id": "string",
"payer_ip": "string",
"payer_address": {
"country": "string",
"state_or_province": "string",
"city": "string",
"county": "string",
"region_code": "string",
"street": "string",
"house_number_or_name": "string",
"postal_code": "string"
},
"internal_transaction_trace_infos": [
{
"trace_id": "string",
"channel_name": "string",
"reference": "string",
"ouid": "string",
"merchant_ouid": "string",
"channel_midas_ouid": "string",
"merchant_midas_ouid": "string",
"multi_ou_version": "string"
}
],
"channel_addition_datas": [
{
"channel_name": "string",
"channel_contract_mode": "MODE_UNKNOWN",
"channel_account_id": "string",
"channel_real_channels": [
"string"
],
"channel_order_id": "string"
}
]
},
"metadata": {}
}
Error response structure
- application/json
- Response
- Example
Response
Array [
]
Array [
]
details
object[]
The type of the serialized message.
causes
object[]
{
"name": "string",
"message": "string",
"details": [
{
"@type": "string"
}
],
"debug_id": "string",
"causes": [
{
"cause": "string",
"solution": "string"
}
]
}