Create a payout
POST /v2/b2b/currents/createOrder
Request
{
"instructedAmount":{
"currency":"String",
"amount":10
},
"exchange":{
"originCurrency":"String",
"targetCurrency":"String"
},
"outOrderId": "String",
"payerId": "String",
"receiver": {
"bankCountry": "String",
"bankName": "String",
"swiftCode": "String",
"bankAddress": "String",
"routingNumber": "String",
"bankAccountCurrency": "String",
"bankAccountNumber": "String",
"bankAccountName": "String",
"bankCode": "String",
"bankBranchName": "String",
"bankBranchCode": "String",
"idCardNumber": "String",
"birthDate": "String",
"address": "String",
"extraCode": {
"bsbCode": "String",
"ifscCode": "String",
"pan": "String",
"sortCode": "String"
},
"cardHoldType": "String"
},
"type": "String"
}
| Parameter | Type | Requried | Description |
|---|---|---|---|
instructedAmount.currency | string | Yes | the currency code. See section Appendix A - Currency Codes for the currencies enum. |
instructedAmount.amount | number | Yes | Received amount |
exchange.originCurrency | string | Yes | Payer account currency. See section Appendix A - Currency Codes for the currencies enum. |
exchange.targetCurrency | string | Yes | Receiver account currency. See section Appendix A - Currency Codes for the currencies enum. |
outOrderId | string | No | External system order number |
payerId | string | Yes | PingPong user id |
type | string | Yes | WITHDRAW,SUPPLIER |
receiver.bankCountry | string | Yes | Bank Location.See section Appendix B - Country or Area for the country enum. |
receiver.bankName | string | Yes | Bank name. |
receiver.swiftCode | string | No | SWIFT/BIC |
receiver.bankAddress | string | No | Remittance remark.. |
receiver.routingNumber | string | No | Routing Number |
receiver.bankAccountNumber | string | Yes | IBAN/Account Number |
receiver.accountName | string | Yes | Account Name |
receiver.bankCode | string | No | Bank Code |
receiver.bankBranchName | string | No | Bank Name. |
receiver.bankBranchCode | string | No | Transit Number / Branch Number/Bank State Branch Code (BSB). |
receiver.idCardNumber | string | No | ID number |
receiver.birthDate | string | No | Customer's birthday |
receiver.address | string | No | Address |
receiver.extraCode | json | No | Sort code/BSB number/IFSC & PAN |
receiver.cardHoldType | string | Yes | Personal or Company |
Response
{
"code": 0,
"message": "OK",
"data": {
"payMoney": {
"currency": "String",
"amount": 5.05
},
"targetMoney": {
"currency": "String",
"amount": 10.00
},
"serviceCharge": {
"feeRate": null,
"cutFeeRate": null,
"fee": {
"currency": "String",
"amount": 0.05
},
"cutFee": {
"currency": "String",
"amount": 0.00
},
"finalFee": {
"currency": "String",
"amount": 0.05
},
"fixFee": {
"currency": "String",
"amount": 0.0
},
"lessThanMinPayoutFee": {
"currency": "String",
"amount": 0
},
"minPayout": {
"currency": "String",
"amount": 0.0
}
},
"orderId": "String",
"status": "String",
"failReason": null,
"remark": null,
"receiver": {
"bizId": "String",
"outOrderId": null,
"bankAccountNumber": "String",
"bankAccountName": "String",
"bankName": "String",
"firstName": "String",
"lastName": null,
"userNick": null
},
"lockRateId": null,
"exchange": {
"originCurrency": "String",
"targetCurrency": "String",
"rateId": null,
"exchangeRate": 2
},
"deliveryDate": null
}
}
| Parameter | Type | Description |
|---|---|---|
payMoney | json | PingPong account should pay amount of money |
targetMoney | json | Receiver finally will receiver amount of money |
serviceCharge.finalFee | json | PingPong Service Charge |
orderId | string | Order ID |
status | string | The payment status, can be one of: pending success fail. |
receiver | json | Receiver Bank Info |
exchange | json | PingPong Exchange Info |