Creates a payout
Endpoint to create payouts
Authorization
authorization
In: header
Request Body
application/json
Attributes to create a payout
A core account identifier
^[A-Za-z]{2,6}_[\w-]{22}$"lacc_5tgliBmzjZ6mpQPRbQjfKj"A description for the payout
"string"A unique identifier to handle idempotency. If the identifier already exists, the payout creation is skipped and the HTTP code response is 200. If not, a new payout is created and the HTTP code response is 201.
"1234859"A tenant-managed flat map for providing additional data about the payout. The values are stored and displayed as strings, and the provided information will be returned as-is in the payout details.
{
"id": 3,
"reference": 123
}Specifies the way or process used to execute the payout. Each method is only available for certain countries and currencies, and the processing time for completing a payout will vary depending on the selected method.
"co_ach" | "co_transfiya" | "co_mono_turbo" | "co_breb""co_ach"A reference for the payout
"string"The amount to be debited from the source account, specified in the same currency as the source account, This amount include the fees if were configured. If this field is null, its value can be automatically calculated from the target amount.
The amount to be credited to the target account, specified in the same currency as the target account. If this field is null, its value can be automatically calculated from the source amount.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.cert.monoban.co/v1/core/payouts" \ -H "Content-Type: application/json" \ -d '{ "target": { "country": "CO", "currency": "COP", "kind": "co_bank_account", "account_number": "123456789", "account_type": "savings_account", "bank_code": "007", "payee": { "document_number": "451730", "document_type": "CC", "kind": "co_person", "name": "Pedro Santiago Perez Rodriguez" } }, "account_id": "lacc_5tgliBmzjZ6mpQPRbQjfKj", "external_id": "1234859", "method": "co_ach" }'{
"target": {
"country": "CO",
"currency": "COP",
"kind": "co_bank_account",
"account_number": "123456789",
"account_type": "savings_account",
"bank_code": "007",
"payee": {
"document_number": "451730",
"document_type": "CC",
"email": "someone@gmail.com",
"kind": "co_person",
"name": "Pedro Santiago Perez Rodriguez",
"phone_number": "+573000000000"
}
},
"account_id": "lacc_5tgliBmzjZ6mpQPRbQjfKj",
"calculated_fees": {
"bank_transfer": {
"amount": {
"amount": 100000000,
"currency": "COP"
},
"id": "fee_5tgliBmzjZ6mpQPRbQjfKj"
},
"bank_transfer_gmf": {
"amount": {
"amount": 100000000,
"currency": "COP"
},
"id": "fee_5tgliBmzjZ6mpQPRbQjfKj"
}
},
"description": "string",
"external_id": "1234859",
"id": "cpout_5tgliBmzjZ6mpQPRbQjfKj",
"metadata": {
"id": 3,
"reference": 123
},
"method": "co_ach",
"method_params": {},
"reference": "string",
"source_amount": {
"amount": 100000000,
"currency": "COP"
},
"state": "string",
"state_reason": "string",
"target_amount": {
"amount": 100000000,
"currency": "COP"
}
}{
"target": {
"country": "CO",
"currency": "COP",
"kind": "co_bank_account",
"account_number": "123456789",
"account_type": "savings_account",
"bank_code": "007",
"payee": {
"document_number": "451730",
"document_type": "CC",
"email": "someone@gmail.com",
"kind": "co_person",
"name": "Pedro Santiago Perez Rodriguez",
"phone_number": "+573000000000"
}
},
"account_id": "lacc_5tgliBmzjZ6mpQPRbQjfKj",
"calculated_fees": {
"bank_transfer": {
"amount": {
"amount": 100000000,
"currency": "COP"
},
"id": "fee_5tgliBmzjZ6mpQPRbQjfKj"
},
"bank_transfer_gmf": {
"amount": {
"amount": 100000000,
"currency": "COP"
},
"id": "fee_5tgliBmzjZ6mpQPRbQjfKj"
}
},
"description": "string",
"external_id": "1234859",
"id": "cpout_5tgliBmzjZ6mpQPRbQjfKj",
"metadata": {
"id": 3,
"reference": 123
},
"method": "co_ach",
"method_params": {},
"reference": "string",
"source_amount": {
"amount": 100000000,
"currency": "COP"
},
"state": "string",
"state_reason": "string",
"target_amount": {
"amount": 100000000,
"currency": "COP"
}
}{
"code": "400 Bad Request",
"errors": [
{
"error_code": "validation_error",
"message": "Generic changeset errors",
"path": null,
"url": null
}
],
"id": "log_7MkWaFqvfosB8fzHhb1Eql",
"message": "Malformed request"
}{
"code": "401 Unauthorized",
"errors": [
{
"error_code": "expired_token",
"message": "The token is expired, inactive, or doesn't exist.",
"path": null,
"url": null
}
],
"id": "log_7MkWaFqvfosB8fzHhb1Eql",
"message": "Authorization header is missing or invalid."
}{
"code": "403 Forbidden",
"errors": [
{
"error_code": "not_authorized",
"message": "Not authorized to have access to this resource.",
"path": null,
"url": null
}
],
"id": "log_7MkWaFqvfosB8fzHhb1Eql",
"message": "Not authorized to have access to this resource"
}{
"code": "422 Unprocessable Entity",
"errors": [
{
"error_code": "missing_field",
"message": "The field is missing on the request body or parameters.",
"path": "#/path/to/field",
"url": null
}
],
"id": "log_7MkWaFqvfosB8fzHhb1Eql",
"message": "Validation errors"
}