SLslashfi

Create a recipient

Changed on

Create a person or business to pay. Add destinations to it to send them money.

post/v2/recipients

Request

  • Base URL
    https://api.slash.com
  • URL
    https://api.slash.com/v2/recipients
  • Auth
    API key in header X-API-Key

Headers

X-Idempotency-Keystring required

Unique caller-generated key for one create request. Once an authenticated, schema-valid request reaches the operation, the key is permanently consumed for that operation and legal entity whether the operation succeeds or fails. Reusing it in that scope returns 409 and never replays a response, unlike API v1, which replays the original response for a matching key.

Request body

namestring required

Display name visible to your organization.

recipientType'contact' | 'vendor' required

contact for a person (shown as "Person" in the Slash dashboard), vendor for a business.

recipientLegalNamestring required
recipientEmailstring email

Response

The created recipient.

idstring required

Recipient id.

namestring required

Display name visible to your organization.

recipientType'contact' | 'vendor' required

contact is a person (shown as "Person" in the Slash dashboard); vendor is a business.

recipientLegalNamestring required
recipientEmailstring
status'active' | 'archived' required
createdAtstring date-time required
archivedAtstring date-time

Changes