logo

Payouts

Search payouts

Search payouts. Recommended to filter by OrderID (eg. ?filter=OrderID:1234_567890).

SecurityApiKey
Request
query Parameters
filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

header Parameters
Organization-Id
string

The gaming server id maps to an organization in Rebilly (if not set will choose default user gaming server)

Responses
200

Payouts were retrieved successfully

Response Schema: application/json
Array
PayoutMethod
required
string (AlternativeMethod)

The name of the alternative method. The value supplied here will determine where the payment is routed.

Enum: "Alipay" "Aircash" "Airpay" "AstroPay Card" "AstroPay-GO" "bank-transfer" "bank-transfer-2" "bank-transfer-3" "bank-transfer-4" "bank-transfer-5" … 271 more
CardID
string

The ID of the card (maps to a payment card in Rebilly). Required when the payout method is payment-card.

FinancialAccountID
string

The ID corresponding to the account to be paid. Required when the payout method is alternative.

TransactionID
string <= 50 characters

The transaction identifier string. This will be unique for the merchant in Rebilly. We will attempt to use the payout export reference, but if it isn't unique, we will generate a variation.

PayoutExportReference
required
string <= 50 characters

The payout identifier string, also known as the payment export reference. This must be unique (for the merchant) within a 24-hour period, to prevent duplicate requests.

GatewayAccountID
required
string

The Merchant account to be used for the payout.

CasinoID
required
string <= 50 characters

The casino id maps to a website identifier string in Rebilly.

GSID
string <= 50 characters

The gaming server id maps to an organization in Rebilly (read-only).

PlayerID
required
string <= 50 characters

The player identifier string (maps to a customer in Rebilly). It is composed of two parts concatenated by an underscore. The first part is the registration casino id, and the second part the user id.

OrderCurrency
required
string <ISO-4217-alpha-3>

The ISO 4217 alpha-3 code. The code is three characters. Currencies must be configured in the gateway account.

OrderAmount
required
string

The payment amount with no currency sign (45.00). It is important to check the PurchaseAmount, which may be different from the OrderAmount in case the Player changed the order mid-process, which could be due to an upsell/bump scenarios.

BillingCurrency
string <ISO-4217-alpha-3>

The ISO 4217 alpha-3 code. In event of dynamic currency conversion, this will be the currency paid out (read-only).

BillingAmount
string

The amount billed. In event of dynamic currency conversion, this will be the amount of the currency paid out (read-only).

BillingDescriptor
string

The billing descriptor that will appear on the cardholders billing statement (read-only).

NotificationURL
required
string <url>

In the event of an offsite payment due to third party verification, this URL will be called by the system when the payment is no longer offsite. In the event of a timeout, or other exceptional type of transaction, the NotificationURL will be used to update in the event the Result changes from unknown to another value.

ExtraData
object

"Extra data list as a map {"field name": "custom value", ...}". The format must follow the saved format. Recommended fields are BannerTagId, RegistrationDate, and DeviceFingerprint. If a global/master user id is available, that would be appropriate too. To test within the sandbox, use these magic values to simulate different outcomes with DesiredResult as key

Magic Value Description
approved The transaction will have an approved result with a status of completed
declined The transaction will have a declined result with a status of completed
timeout-approved The transaction will have a timeout status with an unknown result. After approximately 5 minutes, the timeout will become resolved and will have an approved result with a completed status.
timeout-declined The transaction will have a timeout status with an unknown result. After approximately 5 minutes, the timeout will become resolved and will have a declined result and a completed status.
conn-error-declined The transaction will have a conn-error status with an unknown result. After approximately 5 minutes, it will resolve and become result declined and status completed
sending-declined The transaction will have a status of sending and an unknown result. After 5 minutes, it will resolve and become declined / completed.
pending-approved The transaction will have a status of pending and an unknown result. After 5 minutes, it will resolve to approved/completed.
Status
string

Some status values require special handling.

  • timeout (or conn-error): Rebilly will poll the gateway to determine if it was processed. The transaction should be held open until a determination is made. Rebilly will send a notification to the NotificationURL upon resolution of the timeout and conn-error states.
  • waiting-gateway: Rebilly will poll final status and will send a notification to NotificationURL upon completed
Enum: "pending" "sending" "timeout" "conn-error" "never-sent" "completed" "waiting-gateway"
Result
string

Payout result (read-only). A result of unknown means the payout should be held open/pending for future changes. That may happen because of a timeout or because interaction is necessary for further processing.

Enum: "approved" "declined" "canceled" "abandoned" "unknown"
Acquirer
string

The Acquirer used for the payment (read-only).

ResponseCode
string

A code that maps to a message. The code is a string number between 0 and 1000. See Rebilly response codes (read-only).

ResponseMessage
string

The message mapped from the code (read-only).

ResponseCodeGateway
string

A code from the downstream gateway (read-only).

ResponseMessageGateway
string

The message mapped from the code from the gateway (read-only).

GatewayTransactionID
string

The transaction identifier from the processor or gateway (read-only).

CreatedTime
string <date-time>

Payout created time (read-only)

UpdatedTime
string <date-time>

Payout updated time (read-only)

Array of objects (Links)

The links related to resource

401

Unauthorized

403

Access forbidden

404

Resource was not found

get/pay-outs
Response samples
application/json
[
  • {
    }
]

Retrieve a payout

Retrieve a payout with specified identifier string.

SecurityApiKey
Request
path Parameters
OrderID
required
string

The resource identifier string

header Parameters
Organization-Id
string

The gaming server id maps to an organization in Rebilly (if not set will choose default user gaming server)

Responses
200

Payout was retrieved successfully

Response Schema: application/json
PayoutMethod
required
string (AlternativeMethod)

The name of the alternative method. The value supplied here will determine where the payment is routed.

Enum: "Alipay" "Aircash" "Airpay" "AstroPay Card" "AstroPay-GO" "bank-transfer" "bank-transfer-2" "bank-transfer-3" "bank-transfer-4" "bank-transfer-5" … 271 more
CardID
string

The ID of the card (maps to a payment card in Rebilly). Required when the payout method is payment-card.

FinancialAccountID
string

The ID corresponding to the account to be paid. Required when the payout method is alternative.

TransactionID
string <= 50 characters

The transaction identifier string. This will be unique for the merchant in Rebilly. We will attempt to use the payout export reference, but if it isn't unique, we will generate a variation.

PayoutExportReference
required
string <= 50 characters

The payout identifier string, also known as the payment export reference. This must be unique (for the merchant) within a 24-hour period, to prevent duplicate requests.

GatewayAccountID
required
string

The Merchant account to be used for the payout.

CasinoID
required
string <= 50 characters

The casino id maps to a website identifier string in Rebilly.

GSID
string <= 50 characters

The gaming server id maps to an organization in Rebilly (read-only).

PlayerID
required
string <= 50 characters

The player identifier string (maps to a customer in Rebilly). It is composed of two parts concatenated by an underscore. The first part is the registration casino id, and the second part the user id.

OrderCurrency
required
string <ISO-4217-alpha-3>

The ISO 4217 alpha-3 code. The code is three characters. Currencies must be configured in the gateway account.

OrderAmount
required
string

The payment amount with no currency sign (45.00). It is important to check the PurchaseAmount, which may be different from the OrderAmount in case the Player changed the order mid-process, which could be due to an upsell/bump scenarios.

BillingCurrency
string <ISO-4217-alpha-3>

The ISO 4217 alpha-3 code. In event of dynamic currency conversion, this will be the currency paid out (read-only).

BillingAmount
string

The amount billed. In event of dynamic currency conversion, this will be the amount of the currency paid out (read-only).

BillingDescriptor
string

The billing descriptor that will appear on the cardholders billing statement (read-only).

NotificationURL
required
string <url>

In the event of an offsite payment due to third party verification, this URL will be called by the system when the payment is no longer offsite. In the event of a timeout, or other exceptional type of transaction, the NotificationURL will be used to update in the event the Result changes from unknown to another value.

ExtraData
object

"Extra data list as a map {"field name": "custom value", ...}". The format must follow the saved format. Recommended fields are BannerTagId, RegistrationDate, and DeviceFingerprint. If a global/master user id is available, that would be appropriate too. To test within the sandbox, use these magic values to simulate different outcomes with DesiredResult as key

Magic Value Description
approved The transaction will have an approved result with a status of completed
declined The transaction will have a declined result with a status of completed
timeout-approved The transaction will have a timeout status with an unknown result. After approximately 5 minutes, the timeout will become resolved and will have an approved result with a completed status.
timeout-declined The transaction will have a timeout status with an unknown result. After approximately 5 minutes, the timeout will become resolved and will have a declined result and a completed status.
conn-error-declined The transaction will have a conn-error status with an unknown result. After approximately 5 minutes, it will resolve and become result declined and status completed
sending-declined The transaction will have a status of sending and an unknown result. After 5 minutes, it will resolve and become declined / completed.
pending-approved The transaction will have a status of pending and an unknown result. After 5 minutes, it will resolve to approved/completed.
Status
string

Some status values require special handling.

  • timeout (or conn-error): Rebilly will poll the gateway to determine if it was processed. The transaction should be held open until a determination is made. Rebilly will send a notification to the NotificationURL upon resolution of the timeout and conn-error states.
  • waiting-gateway: Rebilly will poll final status and will send a notification to NotificationURL upon completed
Enum: "pending" "sending" "timeout" "conn-error" "never-sent" "completed" "waiting-gateway"
Result
string

Payout result (read-only). A result of unknown means the payout should be held open/pending for future changes. That may happen because of a timeout or because interaction is necessary for further processing.

Enum: "approved" "declined" "canceled" "abandoned" "unknown"
Acquirer
string

The Acquirer used for the payment (read-only).

ResponseCode
string

A code that maps to a message. The code is a string number between 0 and 1000. See Rebilly response codes (read-only).

ResponseMessage
string

The message mapped from the code (read-only).

ResponseCodeGateway
string

A code from the downstream gateway (read-only).

ResponseMessageGateway
string

The message mapped from the code from the gateway (read-only).

GatewayTransactionID
string

The transaction identifier from the processor or gateway (read-only).

CreatedTime
string <date-time>

Payout created time (read-only)

UpdatedTime
string <date-time>

Payout updated time (read-only)

Array of objects (Links)

The links related to resource

401

Unauthorized

403

Access forbidden

404

Resource was not found

get/pay-outs/{OrderID}
Response samples
application/json
{
  • "PayoutMethod": "Alipay",
  • "CardID": "411111",
  • "FinancialAccountID": "123-456-789-abc-ef1-234-567",
  • "TransactionID": "22_4567899",
  • "PayoutExportReference": "22_4567899",
  • "GatewayAccountID": "rebilly_001",
  • "CasinoID": "22",
  • "GSID": "45",
  • "PlayerID": "22_112233",
  • "OrderCurrency": "USD",
  • "OrderAmount": "45.00",
  • "BillingCurrency": "USD",
  • "BillingAmount": "45.00",
  • "BillingDescriptor": "My descriptor",
  • "NotificationURL": "string",
  • "ExtraData": {
    },
  • "Status": "completed",
  • "Result": "approved",
  • "Acquirer": "Natwest",
  • "ResponseCode": "00",
  • "ResponseMessage": "Successful approval",
  • "ResponseCodeGateway": "00",
  • "ResponseMessageGateway": "Approved transaction",
  • "GatewayTransactionID": "11111-22222-33333-44444",
  • "CreatedTime": "2019-08-24T14:15:22Z",
  • "UpdatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}

Create a payout

Create a payout for either Rebilly-originated (exposure) payments by using the Rebilly FinancialAccountID or the MGS CardID. Alternatively, you can create any non-exposure payouts by supplying the gateway's account id or payment instrument information required to do the payout.

This API will be stable and will extend in the future by adding additional types of payment instruments.

Rebilly will create the customer if it does not exist.

SecurityApiKey
Request
path Parameters
OrderID
required
string

The resource identifier string

header Parameters
Organization-Id
string

The gaming server id maps to an organization in Rebilly (if not set will choose default user gaming server)

Request Body schema: application/json
required

Payout resource

required
PaymentInstrumentGeneric (object) or PaymentInstrumentMGSCardID (object) or PaymentInstrumentBankAccount (object) or PaymentInstrumentInteracETransfer (object)

The payment instrument details used to make the payout.

DOB
string <date>

The DOB is the date of birth of the player in ISO 8601 full-date format (yyyy-mm-dd).

IpAddress
string <ipv4>

The ipv4 address in dotted decimal format, such as 127.0.0.1.

Email
string <email>

The Email must match an email regex, and also be at a domain with a valid MX record. Rebilly will not send any emails.

FirstName
string [ 3 .. 45 ] characters

The player's first name.

LastName
string [ 3 .. 45 ] characters

The player's last name.

Address
string <= 60 characters

The Address refers to the street address, with a max length of 60 characters.

Address2
string <= 60 characters

The Address2 refers to the street address, with a max length of 60 characters.

City
string <= 45 characters

The city.

Region
string <= 45 characters

The Region refers to the state, province, territory, parish, or region.

Country
string <ISO-3166-1-alpha-2> <= 2 characters

The Country refers to the ISO 3166-1 alpha-2. Two characters max.

PostalCode
string <= 10 characters

The PostalCode which is also known as the post code or zip code.

PhoneNumber
string <= 20 characters

The telephone number may be either a landline or mobile.

PayoutExportReference
required
string <= 50 characters

The payout identifier string, also known as the payment export reference. This must be unique (for the merchant) within a 24-hour period, to prevent duplicate requests.

GatewayAccountID
string

The Merchant account to be used for the payout.

CasinoID
required
string <= 50 characters

The casino id maps to a website identifier string in Rebilly.

PlayerID
required
string <= 50 characters

The player identifier string (maps to a customer in Rebilly). It is composed of two parts concatenated by an underscore. The first part is the registration casino id, and the second part the user id.

OrderCurrency
required
string <ISO-4217-alpha-3>

The ISO 4217 alpha-3 code. The code is three characters. Currencies must be configured in the gateway account.

OrderAmount
required
string

The payout amount with no currency sign (45.00).

NotificationURL
required
string <url>

In the event of an offsite payment due to third party verification, this URL will be called by the system when the payment is no longer offsite. In the event of a timeout, or other exceptional type of transaction, the NotificationURL will be used to update in the event the Result changes from unknown to another value.

ExtraData
object

"Extra data list as a map {"field name": "custom value", ...}". The format must follow the saved format. Recommended fields are BannerTagId, RegistrationDate, and DeviceFingerprint. If a global/master user id is available, that would be appropriate too.

Responses
201

Payout was created

Response Schema: application/json
PayoutMethod
required
string (AlternativeMethod)

The name of the alternative method. The value supplied here will determine where the payment is routed.

Enum: "Alipay" "Aircash" "Airpay" "AstroPay Card" "AstroPay-GO" "bank-transfer" "bank-transfer-2" "bank-transfer-3" "bank-transfer-4" "bank-transfer-5" … 271 more
CardID
string

The ID of the card (maps to a payment card in Rebilly). Required when the payout method is payment-card.

FinancialAccountID
string

The ID corresponding to the account to be paid. Required when the payout method is alternative.

TransactionID
string <= 50 characters

The transaction identifier string. This will be unique for the merchant in Rebilly. We will attempt to use the payout export reference, but if it isn't unique, we will generate a variation.

PayoutExportReference
required
string <= 50 characters

The payout identifier string, also known as the payment export reference. This must be unique (for the merchant) within a 24-hour period, to prevent duplicate requests.

GatewayAccountID
required
string

The Merchant account to be used for the payout.

CasinoID
required
string <= 50 characters

The casino id maps to a website identifier string in Rebilly.

GSID
string <= 50 characters

The gaming server id maps to an organization in Rebilly (read-only).

PlayerID
required
string <= 50 characters

The player identifier string (maps to a customer in Rebilly). It is composed of two parts concatenated by an underscore. The first part is the registration casino id, and the second part the user id.

OrderCurrency
required
string <ISO-4217-alpha-3>

The ISO 4217 alpha-3 code. The code is three characters. Currencies must be configured in the gateway account.

OrderAmount
required
string

The payment amount with no currency sign (45.00). It is important to check the PurchaseAmount, which may be different from the OrderAmount in case the Player changed the order mid-process, which could be due to an upsell/bump scenarios.

BillingCurrency
string <ISO-4217-alpha-3>

The ISO 4217 alpha-3 code. In event of dynamic currency conversion, this will be the currency paid out (read-only).

BillingAmount
string

The amount billed. In event of dynamic currency conversion, this will be the amount of the currency paid out (read-only).

BillingDescriptor
string

The billing descriptor that will appear on the cardholders billing statement (read-only).

NotificationURL
required
string <url>

In the event of an offsite payment due to third party verification, this URL will be called by the system when the payment is no longer offsite. In the event of a timeout, or other exceptional type of transaction, the NotificationURL will be used to update in the event the Result changes from unknown to another value.

ExtraData
object

"Extra data list as a map {"field name": "custom value", ...}". The format must follow the saved format. Recommended fields are BannerTagId, RegistrationDate, and DeviceFingerprint. If a global/master user id is available, that would be appropriate too. To test within the sandbox, use these magic values to simulate different outcomes with DesiredResult as key

Magic Value Description
approved The transaction will have an approved result with a status of completed
declined The transaction will have a declined result with a status of completed
timeout-approved The transaction will have a timeout status with an unknown result. After approximately 5 minutes, the timeout will become resolved and will have an approved result with a completed status.
timeout-declined The transaction will have a timeout status with an unknown result. After approximately 5 minutes, the timeout will become resolved and will have a declined result and a completed status.
conn-error-declined The transaction will have a conn-error status with an unknown result. After approximately 5 minutes, it will resolve and become result declined and status completed
sending-declined The transaction will have a status of sending and an unknown result. After 5 minutes, it will resolve and become declined / completed.
pending-approved The transaction will have a status of pending and an unknown result. After 5 minutes, it will resolve to approved/completed.
Status
string

Some status values require special handling.

  • timeout (or conn-error): Rebilly will poll the gateway to determine if it was processed. The transaction should be held open until a determination is made. Rebilly will send a notification to the NotificationURL upon resolution of the timeout and conn-error states.
  • waiting-gateway: Rebilly will poll final status and will send a notification to NotificationURL upon completed
Enum: "pending" "sending" "timeout" "conn-error" "never-sent" "completed" "waiting-gateway"
Result
string

Payout result (read-only). A result of unknown means the payout should be held open/pending for future changes. That may happen because of a timeout or because interaction is necessary for further processing.

Enum: "approved" "declined" "canceled" "abandoned" "unknown"
Acquirer
string

The Acquirer used for the payment (read-only).

ResponseCode
string

A code that maps to a message. The code is a string number between 0 and 1000. See Rebilly response codes (read-only).

ResponseMessage
string

The message mapped from the code (read-only).

ResponseCodeGateway
string

A code from the downstream gateway (read-only).

ResponseMessageGateway
string

The message mapped from the code from the gateway (read-only).

GatewayTransactionID
string

The transaction identifier from the processor or gateway (read-only).

CreatedTime
string <date-time>

Payout created time (read-only)

UpdatedTime
string <date-time>

Payout updated time (read-only)

Array of objects (Links)

The links related to resource

401

Unauthorized

403

Access forbidden

409

Conflict

422

Invalid data was sent

500

Rebilly error. Please contact us to report problem.

503

Rebilly server timeout error. Please contact us to report problem.

put/pay-outs/{OrderID}
Request samples
application/json
{
  • "PaymentInstrument": {
    },
  • "DOB": "2019-08-24",
  • "IpAddress": "127.0.0.1",
  • "Email": "user@example.com",
  • "FirstName": "Arnold",
  • "LastName": "Schwartzenegger",
  • "Address": "31 Guild Street",
  • "Address2": "Apartment 2",
  • "City": "London",
  • "Region": "Westminster",
  • "Country": "GB",
  • "PostalCode": "E8 6XD",
  • "PhoneNumber": "077 8826 0192",
  • "PayoutExportReference": "22_4567899",
  • "GatewayAccountID": "rebilly_001",
  • "CasinoID": "22",
  • "PlayerID": "22_112233",
  • "OrderCurrency": "USD",
  • "OrderAmount": "45.00",
  • "NotificationURL": "string",
  • "ExtraData": {
    }
}
Response samples
application/json
{
  • "PayoutMethod": "Alipay",
  • "CardID": "411111",
  • "FinancialAccountID": "123-456-789-abc-ef1-234-567",
  • "TransactionID": "22_4567899",
  • "PayoutExportReference": "22_4567899",
  • "GatewayAccountID": "rebilly_001",
  • "CasinoID": "22",
  • "GSID": "45",
  • "PlayerID": "22_112233",
  • "OrderCurrency": "USD",
  • "OrderAmount": "45.00",
  • "BillingCurrency": "USD",
  • "BillingAmount": "45.00",
  • "BillingDescriptor": "My descriptor",
  • "NotificationURL": "string",
  • "ExtraData": {
    },
  • "Status": "completed",
  • "Result": "approved",
  • "Acquirer": "Natwest",
  • "ResponseCode": "00",
  • "ResponseMessage": "Successful approval",
  • "ResponseCodeGateway": "00",
  • "ResponseMessageGateway": "Approved transaction",
  • "GatewayTransactionID": "11111-22222-33333-44444",
  • "CreatedTime": "2019-08-24T14:15:22Z",
  • "UpdatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}