paymentType.Product in beta version 🔐👨💻
We are working on our beta version. Stay tuned for its official release! You can also contact your account manager for more information.
card object directly and omit the token.| Field | Required | Type | Description |
|---|---|---|---|
clientTransactionId | ✅ Required | string | a valid Universally Unique Identifier (UUID) |
card | ✅ Required (if you don't provide a token) | object | Contains cardholder details. |
card.name | ✅ Required (if you don't provide a token) | string | Cardholder's full name. |
card.number | ✅ Required (if you don't provide a token) | string | Card number for the payout transaction. |
card.expiryMonth | ✅ Required (if you don't provide a token) | string | Card's expiry month (2-digit format). |
card.expiryYear | ✅ Required (if you don't provide a token) | string | Card's expiry year (2-digit format). |
amount | ✅ Required | object | Transaction amount details. |
amount.currency | ✅ Required | string | The currency of the transaction (Allowed values:PEN ). |
amount.totalAmount | ✅ Required | numeric | The total amount to be transferred. |
paymentType | ✅ Required | string | Defines the type of payment ("OG" (Online Gambling) or "FD"(Funds Disbursement ). |
fullResponse | ⛔️ Optional | string | If sent, it must be set to "v2". |
metadata | ⛔️ Optional | object | Additional key-value data related to the transaction. |
metadata.key1 | ⛔️ Optional | string | Single key for metadata |
recipient | ✅ Required | object | Contains recipient details. |
recipient.address | ✅ Required | string | The recipient’s street address. |
recipient.city | ✅ Required | string | The recipient’s city. |
recipient.zipCode | ✅ Required | string | The recipient’s zip code. |
recipient.country | ✅ Required | string | The recipient’s country. |
webhooks | ⛔️ Optional | array | List of webhook configurations to receive transaction updates. |
webhooks[].events | ⛔️ Optional | array | Keep in mind to use the events associated with the payment method. If you send this object empty, the information created in the transaction request will be taken.(approvedTransaction, declinedTransaction). |
webhooks[].urls | ⛔️ Optional | array | List of URLs to receive webhook callbacks. |
webhooks[].headers | ⛔️ Optional | array | Custom headers for webhook requests. |
webhooks[].headers[].label | ⛔️ Optional | string | Label for the custom header. |
webhooks[].headers[].value | ⛔️ Optional | string | Value for the custom header. |
token | ⛔️ Optional | string | It can be obtained via the Hosted Fields library or the Get Card Payout Token method. If you are not PCI compliance, this token is obtained through the requestCardPayoutToken method and is essential for securely processing payments. If the token is sent, the card object is no longer required. |
curl --location 'https://api-uat.kushkipagos.com/payouts/card/v1/pushFunds' \
--header 'Private-Merchant-Id;' \
--header 'Content-Type: application/json' \
--data '{
"card": {
"name": "John Doe",
"number": "5102589999999913",
"expiryMonth": "08",
"expiryYear": "23"
},
"clientTransactionId": "{{$guid}}",
"amount": {
"currency": "PEN",
"totalAmount": 0.25
},
"fullResponse": "v2",
"paymentType": "FD",
"metadata": {
"key1": "key1"
},
"recipient": {
"address": "Lima Callse S/N",
"city": "Lima",
"country": "PER",
"zipCode": "63368"
}
}'{
"details": {
"amount": {
"currency": "PEN",
"totalAmount": 250
},
"approvalCode": "21324K",
"approvedTransactionAmount": 250,
"binInfo": {
"bank": "PICHINCHA",
"bin": "495703",
"brand": "VISA",
"brandProductCode": "",
"country": "USA",
"type": "credit",
"prepaid": false
},
"clientTransactionId": "7474849895",
"created": 1740693164307,
"merchantId": "20000000100400157000",
"merchantName": "ORIZABA PAYOUTS CARD BRANCH",
"paymentBrand": "VISA",
"responseCode": "00",
"responseText": "Approved and completed successfully",
"transactionId": "951740693164307311",
"transactionReference": "c5a95370-31b4-4d47-8c36-6d187107b7da",
"transactionStatus": "APPROVAL",
"transactionType": "PAYOUT"
},
"ticketNumber": "951740693164307311",
"transactionReference": "c5a95370-31b4-4d47-8c36-6d187107b7da"
}