Skip to main content

CreateAuthorization

POST 

/v1/authorization/create

Create a authorization

Request

Body

required

    application_context

    object

    payment_method

    object

    The method of payment, such as PAYPAL,CREDIT_CARD,GO_PAY pay etc.

    name enum

    [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

    ... an additional 735 values ›

    checkout_payment_methods enum[]

    [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

    contract_template_id string

    wechat pay contract template id

    contract_session_id string

    wechat pay contract session id, returns when contract responds.

    mcc_code string

    wechat pay mcc code, used when request authorization payment.

    contract_sign_expire_time string

    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

    code string

    wechat pay authorization code, used to acquire access_token, openid, etc.

    checkout_page_payment_info

    object

    integrate_method enum

    [REDIRECT, EMBED, POPUP]

    specify how to integrate the checkout page in your end.

    applepay_payment_info

    object

    ewallet_card_payment_type enum

    [UNKNOWN, NATIVE, REDIRECT]

    ewallet card payment type, used to specify the type of ewallet card payment.

    card_info

    object

    card_bin string

    The card bin of the card no.

    card_hash string

    The hash of the card no.

    card_mask string

    The mask of the card, it shows the first six and last four digits of the card.

    expiry_month string

    The expire of month.

    expiry_year string

    The expire of year.

    cvc string

    The card verification value.

    funding_source string

    funding source name

    holder_name string

    The name of card holder.

    card_issuing_country string

    card issuing country

    card_brand string

    card brand

    card_cooperation_brand string

    card cooperation brand

    score string

    card score, a larger value indicates a higher priority

    card_type string

    visa、mc、amex、jcb、Discover : scheme; mada_card:mada_card ..

    card_md5 string

    card number md5

    card_pwd string

    The card verification value.

    selected_brand string

    the selected brand for co-brand.

    card_contract_id string

    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 string

    token authentication verification value

    payment_token string

    network token

    expiry_month string

    token expiry month

    expiry_year string

    token expiry year

    token_brand string

    token tokenbrand

    return_url uri

    The URL where the customer is redirected after the customer approves the payment.

    cancel_url uri

    The URL where the customer is redirected after the customer cancels the payment.

    webhook_url uri

    The URL where the merchant receive the order event after the order updated.

    skip_page_redirect_url uri

    The URL where the customer is redirected if they choose to skip the payment page.

    language_code string

    <= 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

    region_code string

    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

    accept_header string

    The accept header value of the shopper's browser.

    color_depth int32

    accept 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.

    java_enabled boolean

    java support tag

    javascript_enabled boolean

    javaScript support tag

    language string

    IETF BCP 47 language code

    screen_height int32

    screen height

    screen_width int32

    screen width

    time_zone_offset int32

    The difference between UTC time and local time, unit: minute.

    user_agent string

    argument of user browser agent.

    result_page_auto_return_merchant boolean

    auto redirect to merchant,no user clicks. It can also be set in the merchant's global behavior configuration.

    mcc string

    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

    checkout_hide_order_info boolean

    whether to hide order info in checkout page, for CHECKOUT_PAGE payment method.

    client_type enum

    [UNKNOWN, WEB, H5, APP]

    The front-end type in which the user is located.

    reference_id string

    non-empty

    Outside reference number

    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.

  • Array [

  • reference_id string

    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

    currency_code string

    The three-character ISO-4217 currency code that identifies the currency.see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes

    value string

    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

    currency_code string

    The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes

    value string

    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

  • Array [

  • tax_type enum

    [UNKNOWN, ECOMMERCE_CONSUMPTION_TAX]

    tax type

    tax_name string

    non-empty

    tax name

    tax_rate string

    Tax as a percentage of total amount example: value 8 means the tax as a percentage of total amount is 8%

    tax_amount

    object

    currency_code string

    The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes

    value string

    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 string

    tax reference

    item_total

    object

    currency_code string

    The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes

    value string

    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_check_mode enum

    [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.

    tax_mode enum

    [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

    currency_code string

    The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes

    value string

    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

    currency_code string

    The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes

    value string

    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

    currency_code string

    The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes

    value string

    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

    merchant_id string

    non-empty and <= 64 characters

    The id of merchant or sub_merchant

    email_address email

    The email address of merchant.

    description string

    <= 1000 characters

    The purchase description.

    items

    object[]

    The purchase items.

  • Array [

  • id string

    The item id.

    name string

    The item name.

    description string

    The item description.

  • ]

  • purchase_reference string

    The purchase reference

    capture_delay_hours string

    Capture delay hours

    external_amount

    object

    discount_amount

    object

    currency_code string

    The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes

    value string

    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.

    discount_reference string

    non-empty

    The discount reference

    fx_amount

    object

    The FX amount

    after_fx_amount

    object

    currency_code string

    The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes

    value string

    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.

    property name* string
  • ]

  • payer

    object

    email_address email

    The email address of the payer.

    payer_id string

    non-empty

    payer_id payer id in merchant

    name

    object

    prefix string

    The prefix, or title, to the party's name.

    given_name string

    When the party is a person, the party's given, or first, name.

    surname string

    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.

    middle_name string

    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.

    suffix string

    The suffix for the party's name.

    full_name string

    When the party is a person, the party's full name.

    payer_ip ip

    The ip address of the payer.

    payer_interaction enum

    [Ecommerce, ContAuth]

    trusted payer tag

    payer_type enum

    [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.

    payer_gender enum

    [UNKNOWN, FEMALE, MALE]

    gender of payer.

    payer_telephone_number string

    Value must match regular expression ^\+?\d{5,20}$

    The telephone number of the payer.

    billing_address

    object

    Address of payer or payee

    country string

    country (eg. CN) -- use region_code instead

    state_or_province string

    <= 100 characters

    ISO 3166-2 define

    city string

    city

    county string

    county

    region_code string

    region code

    street string

    street name

    house_number_or_name string

    house info

    postal_code string

    <= 100 characters

    address postal code

    payer_address

    object

    Address of payer or payee

    country string

    country (eg. CN) -- use region_code instead

    state_or_province string

    <= 100 characters

    ISO 3166-2 define

    city string

    city

    county string

    county

    region_code string

    region code

    street string

    street name

    house_number_or_name string

    house info

    postal_code string

    <= 100 characters

    address postal code

    payer_statement string

    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 string

    payer login id

    midas_login_id string

    midas login id(muid), Apply only to midasbuy.

    midas_login_id_type string

    midas login id type, Apply only to midasbuy.

    midas_login_id_country string

    midas login id country, Apply only to midasbuy.

    midas_login_id_reg_time string

    midas login id register time, Apply only to midasbuy.

    additional_payment_info string

    additional payment info of channel, collected by checkout page.

    anonymous boolean

    The anonymous indicates whether the payer is anonymous (i.e., not authenticated). If true, the card binding information of the payer cannot be queried.

    authorization_source enum

    [DEFAULT, REGISTER, CONSOLE, SUBSCRIPTION]

    User signing a card binding scenario

    merchant_id string

    <= 64 characters

    The id of merchant. If empty, defaults to the merchant_id of the signature authentication

    metadata

    object

    Extended field

    property name* string

Responses

OK

Response

    create_time string

    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

    update_time string

    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

    id string

    The id of the auth.

    status enum

    [UNKNOWN, PENDING, SUCCESS, FAILED, TERMINATED]

    The contract 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.

  • Array [

  • reference_id string

    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

    currency_code string

    The three-character ISO-4217 currency code that identifies the currency.see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes

    value string

    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

    currency_code string

    The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes

    value string

    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

  • Array [

  • tax_type enum

    [UNKNOWN, ECOMMERCE_CONSUMPTION_TAX]

    tax type

    tax_name string

    non-empty

    tax name

    tax_rate string

    Tax as a percentage of total amount example: value 8 means the tax as a percentage of total amount is 8%

    tax_amount

    object

    currency_code string

    The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes

    value string

    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 string

    tax reference

    item_total

    object

    currency_code string

    The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes

    value string

    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_check_mode enum

    [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.

    tax_mode enum

    [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

    currency_code string

    The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes

    value string

    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

    currency_code string

    The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes

    value string

    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

    currency_code string

    The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes

    value string

    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

    merchant_id string

    non-empty and <= 64 characters

    The id of merchant or sub_merchant

    email_address email

    The email address of merchant.

    description string

    <= 1000 characters

    The purchase description.

    items

    object[]

    The purchase items.

  • Array [

  • id string

    The item id.

    name string

    The item name.

    description string

    The item description.

  • ]

  • purchase_reference string

    The purchase reference

    capture_delay_hours string

    Capture delay hours

    external_amount

    object

    discount_amount

    object

    currency_code string

    The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes

    value string

    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.

    discount_reference string

    non-empty

    The discount reference

    fx_amount

    object

    The FX amount

    after_fx_amount

    object

    currency_code string

    The three-character ISO-4217 currency code that identifies the currency. see: https://en.wikipedia.org/wiki/ISO_4217#Active_codes

    value string

    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.

    property name* string
  • ]

  • links

    object[]

    An array of request-related HATEOAS links. To complete payer payment, use the "payment" link to redirect the payer. The API caller has 3 hours (default setting, this which can be changed by your account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, to redirect your payer. Once redirected, the API caller has 3 hours for the payer to approve the order and either authorize or capture the order. If you are not using the Pay JavaScript SDK to initiate Pay Checkout (in context) ensure that you include application_context.return_url is specified or you will get "We're sorry, Things don't appear to be working at the moment" after the payer approves the payment.

  • Array [

  • rel enum

    [UNKNOWN, PAYMENT, SUBSCRIPTION, AUTHORISE, CAPTURE, UNBIND, QRCODE, QRCODE_IMAGE, PREPAY_TOKEN]

    The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.

    href string

    The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.

    method string

    The HTTP method required to make the related call. Possible values: GET,POST,PUT,DELETE,HEAD,CONNECT,OPTIONS,PATCH.

  • ]

  • metadata

    object

    The addition data

    property name* string

    channel_contract_info

    object

    wechat_pay_payment_info

    object

    contract_template_id string

    wechat pay contract template id

    contract_session_id string

    wechat pay contract session id, returns when contract responds.

    mcc_code string

    wechat pay mcc code, used when request authorization payment.

    contract_sign_expire_time string

    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

    code string

    wechat pay authorization code, used to acquire access_token, openid, etc.

    checkout_page_payment_info

    object

    integrate_method enum

    [REDIRECT, EMBED, POPUP]

    specify how to integrate the checkout page in your end.

    applepay_payment_info

    object

    ewallet_card_payment_type enum

    [UNKNOWN, NATIVE, REDIRECT]

    ewallet card payment type, used to specify the type of ewallet card payment.

    card_info

    object

    card_bin string

    The card bin of the card no.

    card_hash string

    The hash of the card no.

    card_mask string

    The mask of the card, it shows the first six and last four digits of the card.

    expiry_month string

    The expire of month.

    expiry_year string

    The expire of year.

    cvc string

    The card verification value.

    funding_source string

    funding source name

    holder_name string

    The name of card holder.

    card_issuing_country string

    card issuing country

    card_brand string

    card brand

    card_cooperation_brand string

    card cooperation brand

    score string

    card score, a larger value indicates a higher priority

    card_type string

    visa、mc、amex、jcb、Discover : scheme; mada_card:mada_card ..

    card_md5 string

    card number md5

    card_pwd string

    The card verification value.

    selected_brand string

    the selected brand for co-brand.

    card_contract_id string

    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 string

    token authentication verification value

    payment_token string

    network token

    expiry_month string

    token expiry month

    expiry_year string

    token expiry year

    token_brand string

    token tokenbrand

    internal_merchant_addition_data

    object

    内部商户特有字段

    channel_name string

    The channel name.

    merchant_contract_mode enum

    [MODE_UNKNOWN, NEED_CONTRACT, NO_CONTRACT, MIX_CONTRACT]

    channel_contract_mode enum

    [MODE_UNKNOWN, NEED_CONTRACT, NO_CONTRACT]

    channel_account_id string
    channel_real_channels string[]
    channel_order_id string
    payer_ip string

    payer_address

    object

    Address of payer or payee

    country string

    country (eg. CN) -- use region_code instead

    state_or_province string

    <= 100 characters

    ISO 3166-2 define

    city string

    city

    county string

    county

    region_code string

    region code

    street string

    street name

    house_number_or_name string

    house info

    postal_code string

    <= 100 characters

    address postal code

    internal_transaction_trace_infos

    object[]

  • Array [

  • 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

    object[]

    外部渠道附加信息。

  • Array [

  • channel_name string

    The channel name.

    channel_contract_mode enum

    [MODE_UNKNOWN, NEED_CONTRACT, NO_CONTRACT]

    channel_account_id string
    channel_real_channels string[]
    channel_order_id string
  • ]

Loading...