Dominic Republic
Example PayOut Request and Response
Last updated
Example PayOut Request and Response
Last updated
POST https://api.stage.localpayment.com /api/payout
Create a payout order
| Name | Type | Description |
|---|---|---|
{
"externalId": "1689599739",
"internalId": "58b7111e-cb1e-41c1-a85e-b0683bdfb3a7",
"paymentMethod": {
"code": "0080",
"name": "Name",
"description": "ACH",
"paymentMethodType": "BankTransfer"
},
"country": "DOM",
"currency": "DOP",
"amount": 50.0,
"accountNumber": "214.214.00000001",
"clientCode": "0001",
"clientName": "Acme",
"status": {
"code": "100",
"description": "Received",
"detail": "The payout was received"
},
"beneficiary": {
"bank": {
"name": "Banco",
"code": "434911008",
"branch": null,
"account": {
"number": "08019997377947",
"type": "S",
"alias": null,
"pixKey": null,
"phone": null
}
},
"type": "INDIVIDUAL",
"name": "Beneficiary Name",
"lastname": "Beneficiary LastName ",
"document": {
"type": "RNC",
"id": "401-50625-4"
},
"userReference": null,
"email": null,
"phone": null,
"birthdate": "0001-01-01T00:00:00",
"nationality": null,
"address": null
},
"merchant": {
"type": "COMPANY",
"name": "Merchant Name",
"lastname": null,
"document": null,
"userReference": null,
"email": null,
"phone": null,
"birthdate": "0001-01-01T00:00:00",
"nationality": null,
"address": null
},
"sender": {
"type": "INDIVIDUAL",
"name": "Sender Name",
"lastname": "Sender LastName",
"document": {
"type": "RNC",
"id": "401-50625-4"
},
"userReference": null,
"email": null,
"phone": null,
"birthdate": "0001-01-01T00:00:00",
"nationality": null,
"address": null
},
"comment": null,
"exchangeRateToken": null,
"date": {
"creationDate": "2023-07-17T13:15:39.2946708+00:00",
"processedDate": "2023-07-17T13:15:39.3883791+00:00"
},
"errors": null
}
]
{
"externalId": "1669663393",
"internalId": "00000000-0000-0000-0000-000000000000",
"status": null,
"errors": [
{
"code": "719",
"description": "Amount must not be empty and more tan 0"
}
]
}{
"externalId": "{{$timestamp}}",
"country": "DOM",
"currency": "DOP",
"amount": 50.0,
"paymentMethod": {
"type": "BankTransfer",
"code": "0080",
"flow": "direct"
},
"beneficiary": {
"name": "Beneficiary Name",
"lastName": "Beneficiary LastName ",
"type": "INDIVIDUAL",
"document": {
"type": "RNC",
"id": "401-50625-4"
},
"bank": {
"name": "Banco",
"code": "434911008",
"account": {
"number": "08019997377947",
"type": "S"
}
}
},
"sender": {
"type": "INDIVIDUAL",
"name": "Sender Name",
"lastName": "Sender LastName",
"document": {
"type": "RNC",
"id": "401-50625-4"
}
},
"merchant": {
"type": "COMPANY",
"name": "Merchant Name"
},
"accountNumber": "214.214.00000001",
"conceptCode": "0001"
}
]{
"externalId": "1689599739",
"internalId": "58b7111e-cb1e-41c1-a85e-b0683bdfb3a7",
"paymentMethod": {
"code": "0080",
"name": "Name",
"description": "ACH",
"paymentMethodType": "BankTransfer"
},
"country": "DOM",
"currency": "DOP",
"amount": 50.0,
"accountNumber": "214.214.00000001",
"clientCode": "0001",
"clientName": "Acme",
"status": {
"code": "100",
"description": "Received",
"detail": "The payout was received"
},
"beneficiary": {
"bank": {
"name": "Banco",
"code": "434911008",
"branch": null,
"account": {
"number": "08019997377947",
"type": "S",
"alias": null,
"pixKey": null,
"phone": null
}
},
"type": "INDIVIDUAL",
"name": "Beneficiary Name",
"lastname": "Beneficiary LastName ",
"document": {
"type": "RNC",
"id": "401-50625-4"
},
"userReference": null,
"email": null,
"phone": null,
"birthdate": "0001-01-01T00:00:00",
"nationality": null,
"address": null
},
"merchant": {
"type": "COMPANY",
"name": "Merchant Name",
"lastname": null,
"document": null,
"userReference": null,
"email": null,
"phone": null,
"birthdate": "0001-01-01T00:00:00",
"nationality": null,
"address": null
},
"sender": {
"type": "INDIVIDUAL",
"name": "Sender Name",
"lastname": "Sender LastName",
"document": {
"type": "RNC",
"id": "401-50625-4"
},
"userReference": null,
"email": null,
"phone": null,
"birthdate": "0001-01-01T00:00:00",
"nationality": null,
"address": null
},
"comment": null,
"exchangeRateToken": null,
"date": {
"creationDate": "2023-07-17T13:15:39.2946708+00:00",
"processedDate": "2023-07-17T13:15:39.3883791+00:00"
},
"errors": null
}[
{
"externalId": "1689600363",
"internalId": "eea722d4-704a-4370-aa07-f6b6a937f814",
"status": {
"code": "300",
"description": "Rejected",
"detail": "Invalid param + [param name] + [reason]"
},
"errors": [
{
"code": "300",
"description": "Invalid param + [beneficiary.document.id] + doesn´t match regex ^[0-9]{3}[-][0-9]{7}[-][0-9]{1}$"
},
{
"code": "701",
"description": "Invalid bank account number format"
}
],
"comment": null
}
]