List Payout Agent Credentials
List a payout agent's credentials, including revoked ones, newest first. Tokens are never returned by this endpoint. This list is not paginated.
List a payout agent's credentials, including revoked ones, newest first. Tokens are never returned by this endpoint. This list is not paginated.
Authorization
api_key In: header
Path Parameters
ID of the payout agent.
uuidResponse Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v2/payout-agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/credentials"{ "has_more": true, "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "payout_agent_credential", "payout_agent_id": "79fb14fc-ce5a-4ca6-83f8-93ffe10240da", "name": "string", "token": "string", "token_last_four": "string", "active": true, "revoked_at": "2019-08-24T14:15:22Z", "last_used_at": "2019-08-24T14:15:22Z", "created": "2019-08-24T14:15:22Z" } ]}{ "success": false, "message": "string", "error_code": "string", "errors": [ null ]}{ "success": false, "message": "string", "error_code": "string", "errors": [ null ]}{ "success": false, "message": "string", "error_code": "string", "errors": [ null ]}Remove an Approved Recipient
Remove an approval by its approval ID or, for an existing user approval, the external user ID. Already accepted payouts and payout links retain their recipient authorization.
Create a Payout Agent Credential
Issue a credential that authenticates as the payout agent on the Payout Agent API. The response is the only time `token` is returned; Dots stores only a hash of it. A payout agent can have several active credentials.