ProcessCheckoutSchema

Request body for attempting payment on an existing checkout. The required companion fields depend on the selected payment_type, for example card details, saved-card data, or payer information required by a specific payment method.

Fields

  • payment_typestringrequired
    Options:"card""boleto""ideal""blik""bancontact""google_pay""apple_pay"

    Payment method used for this processing attempt. It determines which additional request fields are required.

    Example: "card"

  • minimum: 1maximum: 12

    Number of installments for deferred payments. Available only to merchant users in Brazil.

    Example: 1

  • mandateobject

    Mandate details used when a checkout should create a reusable card token for future recurring or merchant-initiated payments.

    Example: {"type":"recurrent","user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.104 Safari/537.36","user_ip":"172.217.169.174"}

    Show 3 properties
    • typestringrequired
      Options:"recurrent"

      Type of mandate to create for the saved payment instrument.

      Example: "recurrent"

    • user_agentstringrequired

      Browser or client user agent observed when consent was collected.

      Example: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.104 Safari/537.36"

    • user_ipstring

      IP address of the payer when the mandate was accepted.

      Example: "172.217.169.174"

  • cardobject

    Required when payment type is card. Details of the payment card.

    Show 7 properties
    • namestringrequired

      Name of the cardholder as it appears on the payment card.

      Example: "FIRSTNAME LASTNAME"

    • numberstringrequired

      Number of the payment card (without spaces).

      Example: "1234567890123456"

    • expiry_yearstringrequired
      pattern: ^[0-9]{2}([0-9]{2})?$

      Two- or four-digit expiration year in YY or YYYY format.

      Example: "2030"

    • expiry_monthstringrequired
      minLength: 2maxLength: 2pattern: ^(0[1-9]|1[0-2])$

      Two-digit expiration month, from 01 through 12.

      Example: "12"

    • cvvstringrequired
      minLength: 3maxLength: 4

      Three or four-digit card verification value (security code) of the payment card.

      Example: "123"

    • typestringrequired
      Options:"ALELO""AMEX""BANCOMAT""CONECS""CUP""DINERS""DISCOVER""EFTPOS""ELO""ELV""GIROCARD""HIPERCARD""INTERAC""JCB""MAESTRO""MASTERCARD""PLUXEE""SUMUP""SWILE""TICKET""VISA""VISA_ELECTRON""VISA_VPAY""VPAY""VR""UNKNOWN"

      Issuing card network of the payment card used for the transaction.

      Example: "VISA"

    • zip_codestring
      minLength: 5maxLength: 5

      Required five-digit ZIP code. Applicable only to merchant users in the USA.

      Example: "12345"

  • Raw PaymentData object received from Google Pay. Send the Google Pay response payload as-is.

    Example: {"apiVersionMinor":0,"apiVersion":2,"paymentMethodData":{"description":"Visa •••• 1111","tokenizationData":{"type":"PAYMENT_GATEWAY","token":"token-data"},"type":"CARD","info":{"cardNetwork":"VISA","cardDetails":"1111"}}}

  • apple_payobject

    Raw payment token object received from Apple Pay. Send the Apple Pay response payload as-is.

    Example: {"token":{"paymentData":{"data":"si2xuT2ArQo689SfE-long-token","signature":"MIAGCSqGSIb3DQEHA-long-signature","header":{"publicKeyHash":"PWfjDi3TSwgZ20TY/A7f3V6J/1rhHyRDCspbeljM0io=","ephemeralPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEaBtz7UN2MNV0qInJVEEhXy10PU0KfO6KxFjXm93oKWL6lCsxZZGDl/EKioUHVSlKgpsKGin0xvgldfxeJVgy0g==","transactionId":"62e0568bc9258e9d0e059d745650fc8211d05ef7a7a1589a6411bf9b12cdfd04"},"version":"EC_v1"},"paymentMethod":{"displayName":"MasterCard 8837","network":"MasterCard","type":"debit"},"transactionIdentifier":"62E0568BC9258E9D0E059D745650FC8211D05EF7A7A1589A6411BF9B12CDFD04"}}

  • tokenstring

    Token of a saved payment instrument returned by checkout processing or the customer's payment-instruments endpoint. To charge a saved card, set payment_type to card and provide both this token and the associated customer_id instead of raw card details.

    Example: "ba85dfee-c3cf-48a6-84f5-d7d761fbba50"

  • Customer identifier associated with the saved payment instrument. Required when token is provided.

    Example: "MEDKHDTI"

  • Personal details for the customer.

    Show 7 properties
    • First name of the customer.

      Example: "John"

    • last_namestring

      Last name of the customer.

      Example: "Doe"

    • emailstring

      Email address of the customer.

      Example: "user@example.com"

    • phonestring

      Phone number of the customer.

      Example: "+491635559723"

    • format: date

      Date of birth of the customer in YYYY-MM-DD format, without a time or timezone.

      Example: "1993-12-31"

    • tax_idstring
      maxLength: 255

      Identification number used for tax purposes, such as a CPF in Brazil.

      Example: "423.378.593-47"

    • addressobject

      Profile's personal address information.

      Show 6 properties
      • citystring

        City name from the address.

        Example: "Berlin"

      • countrystring

        Two letter country code formatted according to ISO3166-1 alpha-2.

        Example: "DE"

      • line_1string

        First line of the address with details of the street name and number.

        Example: "Sample street"

      • line_2string

        Second line of the address with details of the building, unit, apartment, and floor numbers.

        Example: "ap. 5"

      • Postal code from the address.

        Example: "10115"

      • statestring

        State name or abbreviation from the address.

        Example: "Berlin"

Type to search…