Add agents to a payment

Adds one or more agents to the payment and announces them to the other agents. Unless you initiated the payment, each added agent's for must name only you and parties you act for; only the initiator may add an agent for anyone else.

Required permission: create:agent.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier for the payment.

Body Params
agents
array of objects | null
required

The agents to add.

agents*
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

429

Too Many Requests: more than 6,000 calls in 300 seconds. Every endpoint refuses your calls for the next 10 seconds. Send the request again with a backoff, as Rate limiting explains.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json