CreditTransfer v1.2

This endpoint applies to partner-auth only. See our guide for more information on partner-auth endpoints and authentication.

What can I do with creditTransfer?

Credit Transfer can be used to create new transactions and retrieve information about existing ones.

Issue a POST to create a new transfer.

Use sourceaccount_id and destinationaccount_id to get all transactions between two accounts.

GET /creditTransfer or /creditTransfer/:id

Attribute

Type

Filter

Sort

Description

id

int

Yes

Yes

Unique ID of the resource.

sourceaccount_id

int

Yes

No

Account from which credits will be deducted.

destinationaccount_id

int

Yes

No

Account to which credits will be added.

type

enum

Yes

No

Type of credits to transfer: one of "email", "sms", "inboxtest".

amount

int

No

No

Number of credits to transfer; must be non-zero. If positive, credits will be transferred from the source account to the destination account. If negative, credits will be transferred from destination to source.

note

string/null

No

No

A user-specified note associated with the transaction.

cdate

decimal

No

Yes

Transaction timestamp.

HEAD /creditTransfer or /creditTransfer/:id

Attribute

Type

Presence

Description

id

int

Optional

Unique ID of the resource.

sourceaccount_id

int

Optional

Account from which credits will be deducted.

destinationaccount_id

int

Optional

Account to which credits will be added.

type

enum

Optional

Type of credits to transfer: one of "email", "sms", "inboxtest".

POST /creditTransfer

Attribute

Type

Presence

Description

sourceaccount_id

int

Required

Account from which credits will be deducted.

destinationaccount_id

int

Required

Account to which credits will be added.

type

enum

Required

Type of credits to transfer: one of "email", "sms", "inboxtest".

amount

int

Required

Number of credits to transfer; must be non-zero. If positive, credits will be transferred from the source account to the destination account. If negative, credits will be transferred from destination to source.