Skip to content

Create payment by ID

PUT- payments/{paymentId} (1)

AUTHORIZATIONS (2)

  1. Sandbox server (uses test data)
    https://api.sandbox.payerly.tech/v1/payments/{paymentId}
    Production server (uses live data)
    https://api.payerly.tech/v1/payments/{paymentId}

  2. BearerAuth

PATH PARAMETERS
Parameter Type Description
paymentIdrequired string Merchant payment id (must be unique within the merchant site)
REQUEST BODY SCHEMA: application/json
Parameter Type Description
orderId string Merchant order id (must be unique within the merchant site)
description string Payment description
autoConfirmrequired boolean Do auto payment confirmation (single message system). Pass only true
options object - recurring: Recurring payments
- paymentMethods: List of payment methods (If paymentMethods are not specified, all current payment methods will be available)
returnUrl string Merchant's URL for customer return (in case of additional verification actions)
callbackUrl string Merchant's URL for callback (HTTPS only)
customerrequired object (customer) Customer details:
- accountId: Unique customer account id
- fingerprint: Unique customer device fingerprint
- ip: Customer IP address
- phone: Customer phone (only numbers, with country code)
- email: Customer e-mail address
- fullName: Customer full name
- DocumentType: Customer document type
- Document: Customer document
- country: Customer country (ISO 3166-1 alpha-3)
- address: Customer address
- city: Customer city
- state: Customer state
- postalCode: Customer postal code
- neighborhood: Customer neighborhood address
- birthdate: Customer birthdate
- browserData: Object with browser data:
     - acceptHeader
     - colorDepth
     - language
     - screenHeight
     - screenWidth
     - timezone
     - userAgent
     - javaEnabled
    - windowHeight
     - windowWidth
amountrequired object (amount) Amount object:
- value required: Amount value.
- currency required: Amount currency (e.g., "USD", "EUR")
paymentDatarequired object Payment data object
- typerequired: Payment method type
- object: Various payment method types (e.g., cardResponse, sbpResponse, etc.)
customFields object (customfields)
cf1: Additional field 1
- cf2: Additional field 2
- cf3: Additional field 3
- cf4: Additional field 4
- cf5: Additional field 5
Request samples 
    {
        "orderId": "d3b88d1a-cf17-11ed-afa1-0242ac120002",
        "description": "IPhone 17 Pro",
        "autoConfirm": true,
        "options": [
          "recurring"
          ],
        "returnUrl": "https://result.domain.tld",
        "callbackUrl": "https://callback.domain.tld",
        "customer": {
            "accountId": "df1a2c9e-bc2b-11ed-8332-811eecb5ec73",
            "fingerprint": "30faf01ebf161c7c7673b776820b3517|1ea851ab5b0e311ed9c690828f8dc7c6|eyJEZXZpY2VGaW5nZXJwcmludCI6IjMwZmFmMDFlYmYxNjFjN2M3NjczYjc3NjgyMGIzNTE3In0=",
            "ip": "123.123.123.223",
            "phone": "18001002030",
            "email": "[email protected]",
            "fullName": "John Doe",
            "country": "USA",
            "address": "Av. da Liberdade, 87",
            "city": "Sao Paulo",
            "state": "SP",
            "postalCode": "05907",
            "neighborhood": "6587 Roller Derby Lane, Toronto, ON M1R-0E9, Canada",
            "birthdate": "1960-02-25",
            "browserData": {
                "acceptHeader": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
                "colorDepth": 32,
                "language": "en",
                "screenHeight": 667,
                "screenWidth": 375,
                "timezone": -60,
                "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_7_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.6.4 Mobile/15E148 Safari/604.1",
                "javaEnabled": true,
                "windowHeight": 850,
                "windowWidth": 375
            }
        },
        "amount": {
            "value": "7635.01",
            "currency": "USD"
        },
        "paymentData": {
            "type": "card",
            "object": {
                "encryptedCardData": "fdv1WbxyKrO3pM6arO+ndahIPkFL0QFA+TOTxDVavX7rhbX3rSXKYiTUHY/qhEzyeCPzkSRWycoiZ63bpuygdnMppcAP6v012GfPZoPO/WReeCmoeSXxePSdt0qgHgZwweuj6uVzRdSs27vnrYtN4Ri4hwyP+OMymABwe5CsJSBeD5vlsQBIRkoHfWFGRQh3WUMIk0/thTgWu3dJ17bECg/HXeH2C9v9dkMfK2Det6wM7N4CINziBxp/7Z7TWtSG+pYBT0BFiTpwa/EWmOpj31Lkgoaj5zQuAtX/YmhA5EAiM3d8pYcNXriqEPiUaR2cHgRDKiDTK0AhuY0XJC36iRpSp4ZY1LFbtUQMWGgdZgwFaElQM96e9FEjxge63NkLpMIqP22euz68MFroI1rdtFTeLHMTqFFOC1awQPOI2YekwQ7u0n4wDULGFqBNQ=",
                "cardHolder": "John Doe"
            }
        },
        "customFields": {
            "cf1": "string",
            "cf2": "string",
            "cf3": "string",
            "cf4": "string",
            "cf5": "string"
        }
    }

Payment Data

* encryptedCardData - Encrypted card data from JSON object:
        1. {"pan":"4111111111111111","cvv":"123","exp_month":12,"exp_year":2030}
        2. {"cryptogram":"AwAAAAwAFdXWEu8AAAAAgMRgAgA=","eci":"05","exp_month":11,"exp_year":2030,"pan":"411111111111111"}(cryptogram is a tavv)
* cardHolder - Cardholder name

* token - Payment token

* paymentId - Merchant payment id (must be unique within the merchant site).If a recurring payment is made, the paymentId is specified by the initializing transaction

* bank - Preferred destination bank for transfer.Enum: "ru_alfabank" "ru_gazprom" "ru_open" "ru_psb" "ru_raiffeisen" "ru_sberbank" "ru_tinkoff" "ru_vtb"

* bank  - Bank name
* phoneNumber - Phone number

* bank - Preferred destination bank for transfer.Enum: "ru_alfabank" "ru_gazprom" "ru_open" "ru_psb" "ru_raiffeisen" "ru_sberbank" "ru_tinkoff" "ru_vtb" "az_kapital" "az_unibank" "tj_alif" "uz_humo" "kg_bakai" "kg_mbank" "kg_optima" "uz_uzcard" "tj_dushanbe" "tj_eskhata"

* taxId - Tax ID / CPF (Cadastro de Pessoas Físicas)

* clabe  - CLABE account id
Note

{"bankCode": "banjercitos", "bankName": " Banco Nacional del Ejército, Fuerza Aérea y Armada"}
{"bankCode": "sabadells","bankName": " Banco Sabadell S.A."}
{"bankCode": "cbintercams","bankName": " Intercam Casa de Bolsa S.A."}
{"bankCode": "profuturos","bankName": " Profuturo G.N.P. S.A."}
{ "bankCode": "abccapitals","bankName": "ABC CAPITAL Banco Amigo, S.A"}
{"bankCode": "arcus","bankName": "ARCUS"}
{"bankCode": "aspintegraopcs","bankName": "ASP INTEGRA OPC"}
{"bankCode": "bancocovaltos", "bankName": "BANCO COVALTO"}
{"bankCode": "bancos3s", "bankName": "BANCO S3"}
{"bankCode": "bancreas","bankName": "BANCREA"} {"bankCode": "bankofchinas","bankName": "BANK OF CHINA" }
{"bankCode": "bankaools","bankName": "BANKAOOL"}
{"bankCode":"bbases","bankName":"BBASE"},
{"bankCode":"bbvas","bankName":"BBVA Bancomer S.A."},
{"bankCode":"bancoppels","bankName":"BanCoppel S.A."},
{"bankCode":"afirmes","bankName":"Banca Afirme S.A."},
{"bankCode":"autofins","bankName":"Banco Autofin México, S.A."},
{"bankCode":"aztecas","bankName":"Banco Azteca S.A."},
{"bankCode":"banortes","bankName":"Banco Mercantil del Norte S.A."},
{"bankCode":"bmonexs","bankName":"Banco Monex S.A."},
{"bankCode":"bancomexts","bankName":"Banco Nacional de Comercio Exterior"},
{"bankCode":"banamexs","bankName":"Banco Nacional de México S.A."},
{"bankCode":"banobrass","bankName":"Banco Nacional de Obras y Servicios Públicos"},
{"bankCode":"pagatodos","bankName":"Banco PagaTodo S.A."},
{"bankCode":"banregios","bankName":"Banco Regional de Monterrey"},
{"bankCode":"vepormass","bankName":"Banco Ve por Más S.A."},{"bankCode":"banxicos","bankName":"Banco de México."},
{"bankCode":"babiens","bankName":"Banco del Ahorro Nacional y Servicios Financieros."},
{"bankCode":"bajios","bankName":"Banco del Bajío S.A."},
{"bankCode":"bank","bankName":"Bank Transfer"},
{"bankCode":"bankofamericas","bankName":"Bank of America México S.A."},
{"bankCode":"bansis","bankName":"Bansi S.A."},
{"bankCode":"barclays","bankName":"Barclays Bank México S.A."},
{"bankCode":"cajapormexicas","bankName":"CAJA POP MEXICA"},
{"bankCode":"cajatelefonistas","bankName":"CAJA TELEFONISTA"},
{"bankCode":"cibolsas","bankName":"CI BOLSA"},
{"bankCode":"cibancos","bankName":"CIBANCO"},
{"bankCode":"compartamoss","bankName":"COMPARTAMOS"},
{"bankCode":"consubancos","bankName":"CONSUBANCO"},
{"bankCode":"credicapitals","bankName":"CREDICAPITAL"},
{"bankCode":"creditsuisses","bankName":"CREDIT SUISSE"},
{"bankCode":"cristobalcolons","bankName":"CRISTOBAL COLON"},
{"bankCode":"codivalidas","bankName":"CoDi Valida"},
{"bankCode":"dondes","bankName":"DONDE"},
{"bankCode":"finamexs","bankName":"FINAMEX"},
{"bankCode":"fincomuns","bankName":"FINCOMUN"},
{"bankCode":"fompeds","bankName":"FOMPED"},
{"bankCode":"fondofiras","bankName":"FONDO (FIRA)"},
{"bankCode":"gbms","bankName":"GBM"},
{"bankCode":"hipotecariafeds","bankName":"HIPOTECARIA FED"},
{"bankCode":"invexs","bankName":"INVEX"},
{"bankCode":"jpmorgans","bankName":"JP MORGAN"},
{"bankCode":"kuspits","bankName":"KUSPIT"},
{"bankCode":"libertads","bankName":"LIBERTAD"},
{"bankCode":"masaris","bankName":"MASARI"},
{"bankCode":"mifels","bankName":"MIFEL"},
{"bankCode":"mizuhobanks","bankName":"MIZUHO BANK"},
{"bankCode":"monexcbs","bankName":"MONEXCB"},
{"bankCode":"mufgs","bankName":"MUFG"},
{"bankCode":"multivabancos","bankName":"MULTIVA BANCO"},
{"bankCode":"multivacbolsas","bankName":"MULTIVA CBOLSA"},
{"bankCode":"numexicos","bankName":"NU MEXICO"},
{"bankCode":"nafins","bankName":"Nacional Financiera, Sociedad Nacional de Crédito"},
{"bankCode":"nvios","bankName":"Nvio Pagos México"},
{"bankCode":"opms","bankName":"Operadora de Pagos Móviles de México S.A."},
{"bankCode":"actinvers","bankName":"Prudential Bank S.A."},
{"bankCode":"reformas","bankName":"REFORMA"},
{"bankCode":"santanders","bankName":"SANTANDER"},
{"bankCode":"scotiabanks","bankName":"SCOTIABANK"},
{"bankCode":"stps","bankName":"STP"},
{"bankCode":"shinhans","bankName":"Shinhan Bank"},
{"bankCode":"tactivcbs","bankName":"TACTIV CB"},
{"bankCode":"tesoreds","bankName":"TESORED"},
{"bankCode":"valmexs","bankName":"VALMEX"},
{"bankCode":"values","bankName":"Value, S.A. de C.V. Casa de Bolsa"},
{"bankCode":"vectors","bankName":"Vector Casa de Bolsa S.A."},
{"bankCode":"volkswagens","bankName":"Volkswagen Bank"}

* name  - Bank name
* code  - Bank code 
* agency - Bank agency
* account  - Bank account
* accountOperation - Bank account operation

* taxId - Tax ID / CPF (Cadastro de Pessoas Físicas)

* taxId - Tax ID / CPF (Cadastro de Pessoas Físicas)
* cbu - Clave Bancaria Uniforme (CBU)

* iban  - IBAN

Note

If the iban parameters are empty, you will be redirected to the URL provided in the additionalAction.(applies to payment) 

* googlepayResponse  - Google Pay payment data

* applepayResponse  - Apple Pay payment 

* phone - Phone number

* credentials  - Wallet number from the acquirer to which the buyer must transfer the amount   
* fullName  - Name/surname of the wallet holder from the acquirer

* iban  - IBAN
* fullName  - Name/surname of the wallet holder from the acquirer        

* qrData  - link for payment

Payment Data

* taxId - Tax ID / CPF (Cadastro de Pessoas Físicas)

* taxId - Tax ID / CPF (Cadastro de Pessoas Físicas)

* iban  - IBAN
* fullName  - Name/surname of the wallet holder from the acquirer        

* iban  - IBAN
* fullName  - Name/surname of the wallet holder from the acquirer        

* step - form 
* fullName - Name/surname of the wallet holder from the acquirer
* email - Customer e-mail address 
* document - Customer document
* documentType - Customer document type

* extpp  - Identifier of the payment method.Redirects to the payment page.Enum: "vzlavecac2p" "bmigvecac2p" "bmigvecap2c" "uniovecap2c"

* extpp  - Identifier of the payment method.Redirects to the payment 

* credentials - Wallet number from the acquirer to which the buyer must transfer the amount
* bank - Bank name

  * blikCode - unique 6-digit BLIK code

  * qrData - Predirect to scan the QR code on your mobile device

Example

     * webpay  - Identifier of the payment method.Redirects to the payment page

    * webpay  - Identifier of the payment method.Redirects to the payment page

     * multicajatrans  - Identifier of the payment method.Redirects to the payment page

    * pago46  - Identifier of the payment method.Redirects to the payment page

    * hites  - Identifier of the payment method.Redirects to the payment page

    * mach  - Identifier of the payment method.Redirects to the payment page

* khipu - Identifier of the payment method.Redirects to the payment page

    * check  - Identifier of the payment method.Redirects to the payment page

    * servifacil  - Identifier of the payment method.Redirects to the payment page

    * vepuy  - Identifier of the payment method.Redirects to the payment page.Enum: "vzlavecac2p" "bmigvecac2p" "bmigvecap2c" "uniovecap2c"
RESPONSE HEADERS:
Parameter Type Description
Date string(date-time) The Date header indicates the server time.
RESPONSE SCHEMA: application/json
Parameter Type Description
type string Object type (PAYMENT). Value PAYMENT
object object - paymentId: Merchant payment id
- txnId: Unique transaction id
- orderId: Merchant order id
- createdAt: Payment created at
- description: Payment description
- autoConfirm: Do auto payment confirmation (single message system)
- returnUrl: Merchant's URL for customer return (in case of additional verification actions)
- callbackUrl: Merchant's URL for callback
- amount:
    - value: Amount value.
    - currency: Amount currency (e.g., "USD", "EUR")
- convAmount:
    - value: Amount value.
    - currency: Amount currency (e.g., "USD", "EUR")
- paymentMethod: Value card,sbp,sbpp2p, cardp2p,pix,picpay,spei,boleto,banktransfer,banktransferars,pse,iban,mobile.
- paymentData:
    - type: Payment method type
    - object:cardResponse (object) or sbpResponse (object) or sbpp2pResponse (object) or cardp2pResponse (object) or pixResponse (object) or picpayResponse (object) or speiResponse (object) or tedResponse (object) or boletoResponse (object) or pseResponse (object) or banktransferarsResponse (object) or ibanResponse (object) or mobile (object).(see the parameters below)
- paymentToken: Payment token response object.(see the parameters below)
-additionalInfo:
    - rrn - Merchant rrn
- customFields:
    - cf1: Additional field 1
    - cf2: Additional field 2
    - cf3: Additional field 3
    - cf4: Additional field 4
    - cf5: Additional field 5
- status:
    - changedAt: Status changed
    - value: Status value
    - description: Status description
-additionalAction-Additional payment actions (additional customer verification)
    -action:Action type.Value redirect
    -value:Action type value (e.g. customer redirect URL)
error object Error object:
- code: Error code
- description: Error description
- traceId: Unique request trace id (for support requests)
- details: Errors details array
    - value: Error brief
    - description: Error description
    - fields: Errors fields array
        - name: Field name
        - type: Location of field (body, header)
        - value: Field value

Payment token response

Parameter Type Description
type string Object type (TOKEN). Value TOKEN
object object - tokenId: Token id
- expireAt: Token expires at
- customer:
    - accountId: Unique customer account id
    - fingerprint: Unique customer device fingerprint
    - ip: Customer IP address    - phone: Customer phone (only numbers, with country code)
    - email: Customer e-mail address
    - fullName: Customer full name
    - DocumentType: Customer document type
    - Document: Customer document
    - country: Customer country (ISO 3166-1 alpha-3)
    - address: Customer address
    - city: Customer city
    - state: Customer state
    - postalCode: Customer postal code
    - neighborhood: Customer neighborhood address
    - birthdate: Customer birthdate
    - browserData: Object with browser data:
        - acceptHeader
        - colorDepth
        - language
        - screenHeight
        - screenWidth
        - timezone
        - userAgent
        - javaEnabled
        - windowHeight
        - windowWidth
-paymentMethod:Value card.Payment method
.paymentData:
    - type: Value cardResponse.Payment method type
    -object:
        -maskedPan-Masked primary account number
        -expiryDate:Expiration date.
        -cardHolder:Cardholder name
        -cardInfo:Card information
-additionalAction-Additional payment actions (additional customer verification)
    -action:Action type.Value redirect
    -value:Action type value (e.g. customer redirect URL)

Payment Data

* maskedPan - Masked primary account number 
* expiryDate - Expiration date
* cardHolder -  Cardholder name
* cardInfo - Card information object
    * issuerCountry - Card issuer country (ISO 3166-1 alpha-3) 
    * issuerName - Card issuer name

* qrData - Source data for QR-code 

* credentials - Payment credentials
* description - Additional description

* credentials - Payment credentials
* bank - Destination bank for transfer
* description - Additional description

* url  - Payment url
* qrData - Source data for QR-code

* url  - Payment url
* qrData - Source data for QR-code

* url  - Payment url
* qrData - Source data for QR-code

* url  - Payment url

* name  - Bank name
* code  - Bank code 
* agency - Bank agency
* account  - Bank account
* accountOperation - Bank account operation
* document  - Bank document
* beneficiary -Bank beneficiary

* url  - Payment url
* code - Source data for barcode

* url  - Payment url

* url  - Payment url

* iban  - IBAN
* fullName  - Recipient full name        

* phone - Phone number
200 
{
  "type": "PAYMENT",
  "object": {
    "paymentId": "string",
    "txnId": "string",
    "orderId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "description": "string",
    "autoConfirm": true,
    "returnUrl": "string",
    "callbackUrl": "string",
    "amount": {
      "value": "7635.01",
      "currency": "USD"
    },
    "convAmount": {
      "value": "7635.01",
      "currency": "USD"
    },
    "paymentMethod": "mobile",
    "paymentData": {
      "type": "mobile",
      "object": {
        "phone": "79999999999"
      }
    },
    "paymentToken": {
      "type": "TOKEN",
      "object": {
        "tokenId": "string",
        "expireAt": "2019-08-24T14:15:22Z",
        "customer": {
          "accountId": "df1a2c9e-bc2b-11ed-8332-811eecb5ec73",
          "fingerprint": "30faf01ebf161c7c7673b776820b3517|1ea851ab5b0e311ed9c690828f8dc7c6|eyJEZXZpY2VGaW5nZXJwcmludCI6IjMwZmFmMDFlYmYxNjFjN2M3NjczYjc3NjgyMGIzNTE3In0=",
          "ip": "123.123.123.223",
          "phone": "18001002030",
          "email": "[email protected]",
          "fullName": "John Doe",
          "documentType": "string",
          "document": "string",
          "country": "USA",
          "address": "Av. da Liberdade, 87",
          "city": "Sao Paulo",
          "state": "SP",
          "postalCode": "05907",
          "neighborhood": "6587 Roller Derby Lane, Toronto, ON M1R-0E9, Canada",
          "birthdate": "1960-02-25",
          "browserData": {
            "acceptHeader": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
            "colorDepth": 32,
            "language": "en",
            "screenHeight": 667,
            "screenWidth": 375,
            "timezone": -60,
            "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_7_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.6.4 Mobile/15E148 Safari/604.1",
            "javaEnabled": true,
            "windowHeight": 850,
            "windowWidth": 375
          }
        },
        "paymentMethod": "card",
        "paymentData": {
          "type": "cardResponse",
          "object": {
            "maskedPan": "string",
            "expiryDate": "string",
            "cardHolder": "string",
            "cardInfo": {
              "issuerCountry": "USA",
              "issuerName": "string"
            }
          }
        }
      }
    },
    "additionalInfo": {
        "rrn": "4434636542976"
    },
    "customFields": {
      "cf1": "string",
      "cf2": "string",
      "cf3": "string",
      "cf4": "string",
      "cf5": "string"
    },
    "status": {
      "changedAt": "2019-08-24T14:15:22Z",
      "value": "string",
      "description": "string"
    }
  },
  "error": {
    "code": 65535,
    "description": "string",
    "traceId": "string",
    "details": [
      {
        "value": "string",
        "description": "string",
        "fields": [
          {
            "name": "string",
            "type": "string",
            "value": "string"
          }
        ]
      }
    ]
  }
}
400 
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }
401 
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }
402 
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }
403 
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }
404 
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }
405 
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }
429 
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }
default 
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }