--- title: "Server-to-server" method: POST path: "/payment" tags: ["Payment"] --- # Server-to-server `POST /payment` ## Headers - `X-Request-ID` string ## Request body - object - `paymentSource` union, required - object - `type` 'card', required - `number` string, required — Full card number - `expirationYear` string, required — The expiry year of the card - `expirationMonth` string, required — The expiry month of the card - `cvv` string, required — The final three digits printed on the back of the card - `3ds` boolean — Activate the 3DS or SCA authentication process for this transaction. Set to true by default - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - `mid` string — Allows processing transactions via the specified Merchant account ID (MID) - `mpiParameters` object - `authStatus` string — Authorization status - `cavv` string — CAVV value - `eci` string — ECI value - `protocolVersion` string — Version of Protocol - `directoryServerTransactionId` string — Directory Server Transaction ID - `scaExemption` 'lowValue' | 'tra' | 'merchantWhitelist' | 'recurringTransaction' | 'trustedBeneficiary' | 'moto' — SCA exemption - object - `type` 'sepa', required - `iban` string, required — International bank account number in ISO-13616 format - `bic` string — Business identifier code (BIC/SWIFT code) in ISO-9362 format - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - `mid` string — Allows processing transactions via the specified Merchant account ID (MID) - object - `type` 'sofortbanking', required - `bic` string — Business identifier code (BIC/SWIFT code) in ISO-9362 format - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - `mid` string — Allows processing transactions via the specified Merchant account ID (MID) - object - `type` 'onlinebanking', required - `bic` string — Business identifier code (BIC/SWIFT code) in ISO-9362 format - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - `mid` string — Allows processing transactions via the specified Merchant account ID (MID) - `bin` integer — First 6 to 8 digits on the bank card - `bankId` string — ID of the specific bank which user should be routed - object - `type` 'paysafecard', required - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - object - `type` 'giropay', required - `bic` string — Business identifier code (BIC/SWIFT code) in ISO-9362 format - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - `mid` string — Allows processing transactions via the specified Merchant account ID (MID) - object - `type` 'ideal', required - `bic` string — Business identifier code (BIC/SWIFT code) in ISO-9362 format - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - `mid` string — Allows processing transactions via the specified Merchant account ID (MID) - object - `type` 'pps', required - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - `mid` string — Allows processing transactions via the specified Merchant account ID (MID) - object - `type` 'gash', required - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - `mid` string — Allows processing transactions via the specified Merchant account ID (MID) - object - `type` 'przelewy24', required - `bic` string — Business identifier code (BIC/SWIFT code) in ISO-9362 format - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - `mid` string — Allows processing transactions via the specified Merchant account ID (MID) - object - `type` 'bancontact', required - `bic` string — Business identifier code (BIC/SWIFT code) in ISO-9362 format - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - `mid` string — Allows processing transactions via the specified Merchant account ID (MID) - object - `type` 'eps', required - `bic` string — Business identifier code (BIC/SWIFT code) in ISO-9362 format - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - `mid` string — Allows processing transactions via the specified Merchant account ID (MID) - object - `type` 'mybank', required - `bic` string — Business identifier code (BIC/SWIFT code) in ISO-9362 format - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - `mid` string — Allows processing transactions via the specified Merchant account ID (MID) - object - `type` 'consumer', required - `value` string, required — Gateway consumer ID. The value you received in the IPN after the initial transaction - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - object - `type` 'paymentAccountIdWithCvv', required - `paymentAccountId` string, uuid, required — ID of the encoded user payment details - `cvv` string, required - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - object - `type` 'paymentAccountId', required - `paymentAccountId` string, uuid, required — ID of the encoded user payment details - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - object - `type` 'token', required - `value` string, required — Token you have received after using ../tokenize or ../tokenizeWithPaymentAccountId - `3ds` boolean — Activate the 3DS or SCA authentication process for this transaction. Set to true by default - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - object - `type` 'crypto', required - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - object - `type` 'x1', required - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - object - `type` 'payid', required - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - `mid` string — Allows processing transactions via the specified Merchant account ID (MID) - object - `type` 'ach', required - `accountType` 'С' | 'S', required — Specify account type. C - for checking account, S - for savings account - `abaNumber` string, required — Specify the ABA routing number of the bank account - `accountNumber` string, required — Account number - object - `token` string, required - object - `number` string, required — Device Primary Account Number (applicationPrimaryAccountNumber) - `expirationMonth` string, required — Card expiration month, 2 digits - `expirationYear` string, required — Card expiration year, 2 digits - `tavv` string, required — One-time cryptogram from paymentData.onlinePaymentCryptogram - `eci` string — Electronic Commerce Indicator from paymentData.eciIndicator - object - `type` 'pix', required - `cpf` string — CPF - valid Brazil tax ID, 11-digit number - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - `mid` string — Allows processing transactions via the specified Merchant account ID (MID) - object - `type` 'banktransferChile', required - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - `mid` string — Allows processing transactions via the specified Merchant account ID (MID) - object - `type` 'webpay_chile', required - `accountDocType` 'RUT' | 'RUN', required — RUT (Rol Único Tributario) – tax ID number (8–9 digits)
RUN (Rol Único Nacional) – national ID number (8–9 digits) - `accountDocId` string, required - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - `mid` string — Allows processing transactions via the specified Merchant account ID (MID) - object - `type` 'bill1st', required - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - object - `type` 'khipu', required - `accountDocType` 'RUT' | 'RUN', required — RUT (Rol Único Tributario) – tax ID number (8–9 digits)
RUN (Rol Único Nacional) – national ID number (8–9 digits) - `accountDocId` string, required - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - `mid` string — Allows processing transactions via the specified Merchant account ID (MID) - object - `type` 'mach', required - `accountDocType` 'RUT' | 'RUN', required — RUT (Rol Único Tributario) – tax ID number (8–9 digits)
RUN (Rol Único Nacional) – national ID number (8–9 digits) - `accountDocId` string, required - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - `mid` string — Allows processing transactions via the specified Merchant account ID (MID) - object — Google Pay payment source. Token mode only. Decoded card data (cardNumber, expiryMonth, expiryYear, cryptogram) is not supported for Google Pay. - `type` 'googlepay', required - `token` string, required - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - object - `type` 'pse', required - `bankCode` '1815' | '1558' | '1059' | '1040' | '1052' | '1013' | '1032' | '1066' | '1051' | '1001' | '1023' | '1062' | '1063' | '1012' | '1006' | '1071' | '1007' | '1047' | '1061' | '1060' | '1002' | '1065' | '1069' | '1303' | '1808' | '1283' | '1009' | '1812' | '1370' | '1292' | '1289' | '1816' | '1097' | '1551' | '1802' | '1121' | '1814' | '1637' | '1286' | '1070' | '1801' | '1507' | '1809' | '1803' | '1811' | '1019' | '1804', required - `accountDocType` 'RCN' | 'TID' | 'CCI' | 'TEX' | 'CEX' | 'PAS' | 'DIE' | 'NIT', required - `accountDocId` string, required - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - `mid` string — Allows processing transactions via the specified Merchant account ID (MID) - object — Note: `consumer.firstName`, `consumer.lastName`, and `consumer.email` are mandatory for Binance Pay transactions (required by the CardPay gateway). - `type` 'binancepay', required - `emulateCode` string — Emulate a specific decline code for the transaction. Follow the link for the list of decline codes - `mid` string — Allows processing transactions via the specified Merchant account ID (MID) - `partialApproval` object — Optional recommendation to allow partial authorization whenever possible. At least one of `amount` or `percentage` must be provided. If both are provided, the approved amount is calculated as the specified percentage of the payment amount, but must not be less than `amount`. Sending this object does not guarantee a partial approval will occur. Actual support depends on payment methods that support partial approvals - `amount` number — Partial approval amount - `percentage` number — The percentage of the payment amount to approve - `sku` union, required - object - `title` string — Product name displayed on the payment page (3–128 characters) - `siteId` string, required — Gateway site ID (created on the Merchant portal) - `domainName` string — If the property is passed, the site domain name will be replaced - `price` object[], required - `offset` string — Number of days by how long the transaction will be delayed - `amount` number, double — Amount of operation - `currency` string, ISO3 — Currency of operation in ISO3 format - `repeat` union - boolean — Set to false to not repeat the transation, and true - to repeat the transation - integer — Count of repeats - `action` object — Set the values to retry a transaction with the same order ID after a SCA decline - `type` string — Set retry to retry the transaction type. Include all parameters required for 3DS - `id` string — Gateway transaction ID - object - `title` string — Product name displayed on the payment page (3–128 characters) - `name` string, required — SKU name that you added when creating SKU - `action` object — Set the values to retry a transaction with the same order ID after a SCA decline - `type` string — Set retry to retry the transaction type. Include all parameters required for 3DS - `id` string — Gateway transaction ID - object - `title` string — Product name displayed on the payment page (3–128 characters) - `name` string, required — SKU name that you added when creating SKU - `price` object[], required - `offset` string — Number of days by how long the transaction will be delayed - `amount` number, double — Amount of operation - `currency` string, ISO3 — Currency of operation in ISO3 format - `repeat` union - boolean — Set to false to not repeat the transation, and true - to repeat the transation - integer — Count of repeats - `action` object — Set the values to retry a transaction with the same order ID after a SCA decline - `type` string — Set retry to retry the transaction type. Include all parameters required for 3DS - `id` string — Gateway transaction ID - `consumer` object, required - `id` string — Required in case if consumer.externalId or consumer.email are empty - `externalId` string — Required in case if consumer.id is empty - `email` string, email — Required in case if consumer.id is empty, or paymentSource.type is binancepay - `firstName` string — Required in case paymentSource.type is SEPA, card, or binancepay - `lastName` string — Required in case paymentSource.type is SEPA, card, or binancepay - `birthday` string, nullable — Date of birth - `phone` string — Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros). - `country` string, ISO3 — Country name in ISO3 format - `state` string — State name - `city` string — City name - `address` string — Address - `zip` string — Postal code - `ip` string, required — IP address - `cpf` string — CPF (valid tax ID), 11-digit number Required for PIX transactions - `userAgent` string — Consumer's consumer agent Required for 3DS transactions - `deviceId` string — Exodentity device ID - `browserAcceptHeader` string — Exact content of the HTTP accept headers as sent to the 3DS Requestor from the Cardholder's browser. Required for 3DS transactions - `browserJavaEnabled` boolean — Boolean that represents the ability of the cardholder browser to execute Java. Value is returned from the navigator.javaEnabled property. Required for 3DS transactions - `browserLanguage` string — Value representing the browser language as defined in IETF BCP47. The value is limited to 1-8 characters. Value is returned from navigator.language property. Required for 3DS transactions - `browserColorDepth` integer — Value representing the bit depth of the colour palette for displaying images, in bits per pixel. Obtained from Cardholder browser using the screen.colorDepth property. Required for 3DS transactions - `browserScreenHeight` integer — Total height of the Cardholder's screen in pixels. Value is returned from the screen.height property. Required for 3DS transactions - `browserScreenWidth` integer — Total width of the Cardholder's screen in pixels. Value is returned from the screen.width property Required for 3DS transactions - `browserTimezone` string — Time difference between UTC time and the Cardholder browser local time, in minutes. The field is limited to 1-5 characters where the value is returned from the getTimezoneOffset() method. Required for 3DS transactions - `url` object, required - `ipnUrl` string, url — The Instant payment notification (aka IPN or callback) will be sent to this URL after purchase - `redirectUrl` string, url — User will be redirected to this URL after purchase - `metadata` object — Use to store additional information associated with the payment. You can add parameters udf1 and udf2 to pass your internal values such as transactionId, chargeId, orderId, bundleId, or affiliateId. Any values passed will be available in the Merchant Portal - `emailOptions` object - `send` boolean — Set to true by default (in case the email is activated for your Merchant account). Use true to send an email about payment. The value is inherited for all transaction chains (rebill/void/refund/etc.). Check with your account manager which emails you have enabled ## Response `201` Created - object - `payment` object - `code` '0' | '1001' | '1002' | '5000' | '5001' | '5003' | '5004' | '5005' | '5006' | '5007' | '5008' | '5010' | '5012' | '5013' | '5014' | '5015' | '5016' | '5019' | '5030' | '5041' | '5043' | '5046' | '5051' | '5053' | '5054' | '5055' | '5057' | '5058' | '5059' | '5061' | '5062' | '5063' | '5065' | '5070' | '5075' | '5078' | '5079' | '5080' | '5082' | '5085' | '5086' | '5091' | '5093' | '5094' | '5096' | '5099' | '5220' | '5221' | '5222' | '5223' | '5224' | '5225' | '5226' | '5227' | '5228' | '5300' — | code | description |---|---| | 0 | success | | 1001 | Underpayment. Paid amount is less than the requested amount. Indicates a successful transaction | | 1002 | Overpayment. Paid amount is greater than the requested amount. Indicates a successful transaction | | 5000 | General bank decline | | 5001 | Refer to Issuer | | 5003 | Invalid merchant | | 5004 | Pick up card(no fraud) | | 5005 | Do not honor | | 5006 | Payment could not be authorised | | 5007 | Pick up card, special condition (fraud account) | | 5008 | Reattempt not permitted | | 5010 | Partial approval | | 5012 | Invalid transaction | | 5013 | Invalid amount | | 5014 | Invalid card number | | 5015 | No such issuer | | 5016 | Invalid cardholder name | | 5019 | Re-enter transaction | | 5030 | Format error | | 5041 | Lost card, pick up (fraud account) | | 5043 | Stolen card, pick up (fraud account) | | 5046 | Closed account | | 5051 | Insufficient funds | | 5053 | Wrong expiration date | | 5054 | Expired card | | 5055 | Invalid PIN | | 5057 | Transaction not permitted - Card | | 5058 | Transaction not permitted - Terminal | | 5059 | Suspected fraud | | 5061 | Withdrawal amount limit exceeded | | 5062 | Invalid service code, restricted | | 5063 | Security Violation | | 5065 | Activity limit exceeded | | 5070 | PIN data required | | 5075 | PIN tries exceeded | | 5078 | Invalid/nonexistent account specified (general) | | 5079 | Blocked, first used | | 5080 | Credit issuer unavailable | | 5082 | Negative online CAM, dCVV, iCVV, CVV, or CAVV results or offline PIN authentication interrupted | | 5085 | No reason to decline | | 5086 | Cannot verify PIN | | 5091 | Issuer or switch is unavailable | | 5093 | Violation, cannot complete | | 5094 | Duplicate transaction | | 5096 | System error | | 5099 | Expired payment | | 5220 | Authentication failed by card issuer | | 5221 | Authentication is unavailable at the moment | | 5222 | Payment attempt failed or canceled | | 5223 | Rejected authentication by the issuer | | 5224 | Card not enrolled | | 5225 | Attempts processing performed | | 5226 | Card account number not found in the card ranges from the Directory Server | | 5227 | 3D Secure SCA required | | 5228 | Verification not completed, timeout | | 5300 | BIC is not SDD compliant | | 5031 | Invalid cardholder address | | 5032 | Invalid phone number | | 5034 | Invalid currency | - `description` string — Processing details - `action` 'redirect' | 'charge' — | action name | description | |---|---| | charge | Card will be charged immediately. | | redirect | Consumer should be redirected to url for second step | - `url` string, url — URL - `qrCode` string — String to convert to a QR code - `mode` 'sale' | 'auth' — Payment mode - `status` 'success' | 'fail' | 'pending' — Payment status - `amount` number, double — Amount of operation. If [partial approval](https://readme.centrobill.com/docs/partial-approvals#/) is applied (response codes 1001 or 1002), this field reflects the amount actually charged, not the originally requested amount - `currency` string, ISO3 — Currency of operation in ISO3 format - `amountUsd` number, double — Amount of operation in USD - `orderId` string — Gateway transaction ID - `transactionId` string — Payment transaction ID - `descriptor` string — Payment descriptor - `source` object - `method` 'card' | 'applepay' | 'sepa' | 'sofortbanking' | 'ideal' | 'eps' | 'mybank' | 'bancontact' | 'giropay' | 'przelewy24' | 'onlinebanking' | 'skrill' | 'clickandbuy' | 'paypal' | 'pix' | 'boleto' | 'pps' | 'gash' | 'crypto' | 'paygarden' | 'alipay' | 'wechat' | 'unionpay_wallet' | 'voucher' | 'paysafecard' | 'ukash' | 'safeklick' | 'sms' | 'x1' | 'lotericas' | 'picpay' | 'deposit_express' | 'payid' | 'spei' | 'oxxo' | 'codi' | 'todito' | 'banktransfer' | 'cashpayment' | 'pse' | 'efecty' | 'tpaga' | 'pago46' | 'khipu' | 'multibanco' | 'bncr' | 'mbway' | 'papara' | 'havale' | 'webpay_chile' | 'banktransferChile' | 'khipu' | 'mach' — Payment method - `number` string — Card/account number - `brand` string — Account brand (if available) - `bankName` string — Bank name - `bankCountry` string — Bank country - `expirationMonth` string — Card expiration month (if available) - `expirationYear` string — Card expiration year (if available) - `paymentAccountId` string, uuid — ID of the encoded user payment details - `disabled` boolean — If set to true, the paymentAccountId is deactivated for quick sale transactions. If set to false, the paymentAccountId is activated for quick sale transactions. Refer to the appropriate methods to disable or enable the paymentAccountId. - `consumer` object - `id` string, required — Gateway consumer ID (user ID) - `externalId` string — Merchant consumer ID (user ID) - `email` string, email — Email address - `firstName` string — First name - `lastName` string — Last name - `phone` string — Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros). - `country` string, ISO3 — Country name in ISO3 format - `state` string — State name - `city` string — City name - `zip` string — Postal code - `subscription` object - `id` string — Subscription ID - `status` 'active' | 'canceled', nullable — Subscription status - `renewalDate` string, date-time, nullable — Expected date of renewal - `cancelDate` string, date-time, nullable — Expected date of cancel - `cycle` number, nullable — | value | description | |---|---| | 0 | subscription has an initial payment | | n | subscription has n recurrent payments | - `metadata` object — Use to store additional information associated with the payment. You can add parameters udf1 and udf2 to pass your internal values such as transactionId, chargeId, orderId, bundleId, or affiliateId. Any values passed will be available in the Merchant Portal - `timestamp` object - `dateTime` string, date-time - `timezone` string, UTC - `unixTime` string ## Other responses - `400` — Bad Request - `401` — Unauthorized - `403` — Forbidden - `500` — Internal Server Error --- [API](https://skmtc.dev/centrobill/apis/centrobill-payment-api.md) · [All operations](https://skmtc.dev/centrobill/apis/centrobill-payment-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/centrobill/centrobill-payment-api/revisions/d0334aeb55ce/schema)