Skip to main content
GET
/
payoutTargets
/
{payoutTargetId}
Retrieve a Payout Target
curl --request GET \
  --url https://prod.api.palomma.com/v0/payoutTargets/{payoutTargetId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "01HPR8S7YF43PV3QV16TZDC80P",
  "reference": "<string>",
  "description": "<string>",
  "customerId": "01HPR57X6QR5ZRKEEKBSDBW4RA",
  "customerDetails": {
    "reference": "<string>",
    "name": "Pepito Perez",
    "documentType": "cc",
    "documentNumber": "1037551022",
    "email": "[email protected]",
    "phoneNumber": "3013111111"
  },
  "status": "active",
  "statusMessage": "AUTHENTICATION_FAILED",
  "authUrl": "<string>",
  "redirectUrl": "<string>",
  "type": "bankAccount",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Path Parameters

payoutTargetId
string
required

Response

id
string
Example:
reference
string
description
string
customerId
string
Example:
customerDetails
object
status
enum<string>
Available options:
active,
cancelled
Example:
statusMessage
enum<string>
Available options:
AUTHENTICATION_FAILED,
CUSTOMER_CANCELLATION,
DECLINED_BY_BANK,
EXPIRED,
INVALID_ACCOUNT,
NOT_ENOUGH_FUNDS,
ERROR
authUrl
string
redirectUrl
string
type
enum<string>
Available options:
bankAccount
createdAt
string<date-time>
updatedAt
string<date-time>