POST
/
payoutRequests
curl --request POST \
  --url https://prod.api.palomma.com/v0/payoutRequests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "reference": "<string>",
  "payoutTargetId": "<string>",
  "amount": 123,
  "sourceMerchantAccountId": "<string>"
}'
{
  "id": "01HPR8QBF5QKA313RPBSKYB7DS",
  "reference": "<string>",
  "customerId": "01HPR57X6QR5ZRKEEKBSDBW4RA",
  "customerDetails": {
    "reference": "<string>",
    "name": "Pepito Perez",
    "documentType": "cc",
    "documentNumber": "1037551022",
    "email": "pepito@gmail.com",
    "phoneNumber": "3013111111"
  },
  "payoutTargetId": "01HPR8S7YF43PV3QV16TZDC80P",
  "payoutTargetDetails": {
    "reference": "<string>",
    "description": "<string>",
    "type": "bankAccount"
  },
  "status": "processing",
  "statusMessage": "AUTHENTICATION_FAILED",
  "amount": 100000,
  "amountSent": 100000,
  "fee": 500,
  "sourceMerchantAccountId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Response

200
application/json

Payout Request created successfully

The response is of type object.