Rebilly MGS REST API (3.0.0-rc.113)

Download OpenAPI specification:Download

Introduction

The Rebilly API is built on HTTP. Our API is RESTful. It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. You can use your favorite HTTP/REST library for your programming language to use Rebilly's API.

This particular document is for MGS.

Please note, additional members may be added to the response without notice, and the integration should be stable enough to ignore those without breaking functionality.

Key Changes

All notable changes to this project will be documented in this file using the Keep a CHANGELOG principles. This project adheres to Semantic Versioning.

[3.0.0-rc.113] - 2023-11-27:

Added

  • Added documentation for CashierMiscMethod.

[3.0.0-rc.112] - 2023-10-25:

Added

  • Mapped Misc_164 to bank-transfer.

[3.0.0-rc.111] - 2023-10-04:

Added

  • Mapped Misc_162 to ePay.bg.
  • Mapped Misc_163 to cash-deposit.

[3.0.0-rc.110] - 2023-10-02:

Added

  • Added ePayCard to alternative payment methods.
  • Mapped Misc_161 to ePayCard.

[3.0.0-rc.109] - 2023-08-09:

Added

  • Added Aircash to alternative payment methods.
  • Mapped Misc_160 to Aircash.

[3.0.0-rc.108] - 2023-06-27:

Added

  • Mapped Misc_159 to EPS.

[3.0.0-rc.107] - 2023-06-23:

Added

  • Added Directa24Card, Tupay and MercadoPago to alternative payment methods.
  • Mapped Misc_156 to Tupay.
  • Mapped Misc_157 to Directa24Card.
  • Mapped Misc_158 to MercadoPago.

[3.0.0-rc.106] - 2023-05-26:

Added

  • Mapped Misc_155 to Tether.

[3.0.0-rc.105] - 2023-05-17:

Added

  • Added VegaWallet to alternative payment methods.
  • Mapped Misc_154 to VegaWallet.

[3.0.0-rc.104] - 2023-03-30:

Added

  • Added USD-coin to alternative payment methods.
  • Mapped Misc_153 to USD-coin.

[3.0.0-rc.103] - 2023-03-29:

Added

  • Added NordikCoin to alternative payment methods.
  • Mapped Misc_152 to NordikCoin.

[3.0.0-rc.102] - 2023-02-27:

Added

  • Added CPF to ExtraData

[3.0.0-rc.101] - 2023-02-20:

Added

  • Mapped Misc_151 to instant-bank-transfer.

[3.0.0-rc.100] - 2023-02-02:

Added

  • Mapped Misc_150 to PIX.

[3.0.0-rc.99] - 2023-01-19:

Added

  • Added Wallet88 to alternative payment methods.
  • Mapped Misc_149 to Wallet88.

[3.0.0-rc.98] - 2022-12-14:

Added

  • Added KakaoPay, Payco and Samsung Pay to alternative payment methods.
  • Mapped Misc_146 to KakaoPay.
  • Mapped Misc_147 to Payco.
  • Mapped Misc_148 to Samsung Pay.

[3.0.0-rc.97] - 2022-11-09:

Added

  • Mapped Misc_145 to Klarna.

[3.0.0-rc.96] - 2022-11-02:

Added

  • Mapped Misc_144 to CashToCode.

[3.0.0-rc.95] - 2022-10-11:

Added

  • Added InstantPayments to alternative payment method.
  • Mapped Misc_143 to InstantPayments.

[3.0.0-rc.94] - 2022-09-13:

Added

  • Added SafetyPay to alternative payment method.
  • Mapped Misc_142 to SafetyPay.

[3.0.0-rc.93] - 2022-07-15:

Added

  • Added Cleo to alternative payment method.
  • Mapped Misc_140 to Cleo.
  • Mapped Misc_141 to UPI.

[3.0.0-rc.92] - 2022-07-15:

Added

  • Added OXXO to alternative payment method.
  • Mapped Misc_139 to OXXO.

[3.0.0-rc.91] - 2022-07-15:

Added

  • Added BankSEND to alternative payment method.
  • Mapped Misc_138 to BankSEND.

[3.0.0-rc.90] - 2022-05-13:

Added

  • Mapped Misc_136 to bank-transfer.
  • Mapped Misc_137 to PIX.

[3.0.0-rc.89] - 2022-05-05:

Added

  • Mapped Misc_135 to P24.

[3.0.0-rc.88] - 2022-03-17:

Added

  • Mapped Misc_134 to PIX.

[3.0.0-rc.87] - 2022-03-10:

Added

  • Added Bizum to alternative payment method.
  • Mapped Misc_133 to Bizum.

[3.0.0-rc.86] - 2022-03-07:

Added

  • Mapped Misc_132 to iDEAL.

[3.0.0-rc.85] - 2022-03-04:

Added

  • Added PagoEffectivo to alternative payment method.
  • Mapped Misc_131 to PagoEffectivo.

[3.0.0-rc.84] - 2022-01-27:

Added

  • Mapped Misc_129 to POLi.
  • Mapped Misc_130 to rapyd-checkout.

[3.0.0-rc.83] - 2021-11-22:

Added

  • Mapped Misc_128 to Paysafecard.

[3.0.0-rc.82] - 2021-11-12:

Added

  • Added EPS to alternative payment method.
  • Mapped Misc_127 to EPS.

[3.0.0-rc.81] - 2021-11-12:

Added

  • Mapped Misc_125 to voucher.
  • Mapped Misc_126 to bank-transfer.

[3.0.0-rc.80] - 2021-10-11:

Added

  • Mapped Misc_124 to Dimoco-pay-smart.

[3.0.0-rc.79] - 2021-08-12:

Added

  • Mapped Misc_123 to bank-transfer.

[3.0.0-rc.78] - 2021-07-26:

Added

  • Added Sofort payment method.

Changed

  • Mapped Misc_121 to Sofort. It was previously mapped to Worldpay-sofort

Removed

  • Removed unneeded Worldpay-sofort payment method.

[3.0.0-rc.77] - 2021-07-09:

Added

  • Mapped Misc_122 to online-bank-transfer.

[3.0.0-rc.76] - 2021-06-30:

Added

  • Added Worldpay-sofort payment method.
  • Mapped Misc_121 to Worldpay-sofort.

[3.0.0-rc.75] - 2021-06-28:

Added

  • Added Blik, P24 and PayU payment methods.
  • Mapped Misc_118 to Blik.
  • Mapped Misc_119 to P24.
  • Mapped Misc_120 to PayU.

[3.0.0-rc.74] - 2021-06-22:

Added

  • Added Bancontact-mobile.
  • Mapped Misc_117 to Bancontact-mobile.

[3.0.0-rc.73] - 2021-06-11:

Added

  • Mapped Misc_115 to PostFinance-card.
  • Mapped Misc_116 to PostFinance-e-finance.

[3.0.0-rc.72] - 2021-05-24:

Added

  • Mapped Misc_113 to VenusPoint.
  • Mapped Misc_114 to iWallet.

[3.0.0-rc.71] - 2021-05-21:

Added

  • Mapped Misc_112 to MiFinity-eWallet.

[3.0.0-rc.70] - 2021-05-19:

Added

  • Rename PaymentAsia to PaymentAsia-crypto.

[3.0.0-rc.69] - 2021-05-19:

Added

  • Mapped Misc_111 to PaymentAsia.

[3.0.0-rc.68] - 2021-05-13:

Added

  • Added XPay-P2P and XPay-QR payment methods.
  • Changed Misc_108 to XPay-P2P.
  • Mapped Misc_109 to XPay-QR.
  • Mapped Misc_110 to loonie.

[3.0.0-rc.67] - 2021-05-12:

Added

  • Added ezyEFT and loonie payment methods.
  • Mapped Misc_93 to ezyEFT.
  • Mapped Misc_108 to loonie.

[3.0.0-rc.66] - 2021-03-19:

Added

  • Added AstroPay-GO.
  • Mapped Misc_107 to AstroPay-GO.

[3.0.0-rc.65] - 2021-03-19:

Added

  • Mapped Misc_106 to PIX.

[3.0.0-rc.64] - 2021-03-17:

Added

  • Added PhonePe.
  • Mapped Misc_105 to PhonePe.

[3.0.0-rc.63] - 2021-03-09:

Added

  • Mapped Misc_104 to Netbanking.

[3.0.0-rc.62] - 2021-03-08:

Added

  • Mapped Misc_101 to bitcoin.
  • Mapped Misc_102 to Ethereum.
  • Mapped Misc_103 to Tether.

[3.0.0-rc.61] - 2021-03-01:

Changed

  • Renamed alternative payment method Mistercash to Bancontact.

[3.0.0-rc.60] - 2021-02-05:

Added

  • Added new alternative payment method UPI.
  • Mapped Misc_100 to UPI.

[3.0.0-rc.59] - 2021-01-25:

Added

  • Added new alternative payment method Litecoin.
  • Mapped Misc_99 to Litecoin.

[3.0.0-rc.58] - 2021-01-22:

Added

  • Added new alternative payment method Paymero-QR, Ethereum, Tether and picpay.
  • Mapped Misc_94 to Paymero-QR.
  • Mapped Misc_95 to bitcoin.
  • Mapped Misc_96 to Ethereum.
  • Mapped Misc_97 to Tether.
  • Mapped Misc_98 to picpay.

[3.0.0-rc.57] - 2021-01-12:

Added

  • Added new alternative payment method BankSend.
  • Mapped Misc_93 to BankSend.

[3.0.0-rc.56] - 2020-12-22:

Added

  • Added new alternative payment method jpay and oriental-wallet.
  • Mapped Misc_91 to jpay and Misc_92 to oriental-wallet.

[3.0.0-rc.55] - 2020-12-14:

Added

  • Added new alternative payment method Siirto.
  • Mapped Misc_90 to Siirto.

[3.0.0-rc.54] - 2020-12-01:

Added

  • Added new alternative payment method Conekta-oxxo.
  • Added new alternative payment method Conekta-spei.
  • Mapped Misc_89 to Conekta-spei.

[3.0.0-rc.53] - 2020-11-30:

Added

  • Added new alternative payment method PIX.
  • Mapped Misc_88 to PIX.

[3.0.0-rc.52] - 2020-10-28:

Added

  • Added new alternative payment method Airpay.
  • Mapped Misc_87 to Airpay.

[3.0.0-rc.51] - 2020-10-27:

Added

  • Added new alternative payment method bank-transfer-9.
  • Mapped Misc_86 to bank-transfer-9.

[3.0.0-rc.50] - 2020-10-08:

Added

  • Added new alternative payment methods Zimpler, and Webpay.
  • Mapped Misc_85 to Zimpler.

[3.0.0-rc.49] - 2020-10-07:

Added

  • Added new alternative payment methods bank-transfer-6, bank-transfer-7, and bank-transfer-8.
  • Added new alternative payment methods voucher-2, voucher-3, and voucher-4.
  • Added new alternative payment methods Webpay-2, and Webpay Card.
  • Mapped Misc_77 to bank-transfer-6.
  • Mapped Misc_78 to bank-transfer-7.
  • Mapped Misc_79 to bank-transfer-7.
  • Mapped Misc_80 to voucher-2.
  • Mapped Misc_81 to voucher-3.
  • Mapped Misc_82 to voucher-4.
  • Mapped Misc_83 to Webpay-2.
  • Mapped Misc_84 to Webpay Card.

[3.0.0-rc.48] - 2020-09-17:

Added

  • Increased numbers of misc methods up to 200. The Misc_102 - Misc_200 are mapped to invoice, except each every tenth, like Misc_110, Misc_120 and so on which are mapped to phone.
  • Added new alternative payment methods Boleto-2 and Boleto-3.
  • Mapped Misc_73 to Boleto-2.
  • Mapped Misc_74 to Boleto-3.
  • Mapped Misc_75 to Interac-eTransfer.
  • Mapped Misc_76 to TWINT.

[3.0.0-rc.47] - 2020-09-10:

Added

  • Added new alternative payment methods Mistercash, Belfius-direct-net and ING-homepay.
  • Mapped Misc_70 to Mistercash.
  • Mapped Misc_71 to Belfius-direct-net.
  • Mapped Misc_72 to ING-homepay.

[3.0.0-rc.46] - 2020-09-07:

Added

  • Added new alternative payment methods bank-transfer-2, bank-transfer-3, bank-transfer-4 and bank-transfer-5.
  • Mapped Misc_66 to bank-transfer-2.
  • Mapped Misc_67 to bank-transfer-3.
  • Mapped Misc_68 to bank-transfer-4.
  • Mapped Misc_69 to bank-transfer-5.

[3.0.0-rc.45] - 2020-09-02:

Added

  • Added new alternative payment method Khelocard.
  • Mapped Misc_64 to Khelocard.

[3.0.0-rc.44] - 2020-08-27:

  • Mapped Misc_65 to VCreditos.

[3.0.0-rc.43] - 2020-07-24:

  • Mapped Misc_62 to Webmoney.
  • Mapped Misc_63 to AdvCash.

[3.0.0-rc.42] - 2020-07-17:

  • Mapped Misc_52 to Yandex-money.
  • Mapped Misc_53 to Payeer.
  • Mapped Misc_54 to Perfect-money.
  • Mapped Misc_55 to Alfa-click.
  • Mapped Misc_56 to Terminaly-RF.
  • Mapped Misc_57 to Beeline.
  • Mapped Misc_58 to Megafon.
  • Mapped Misc_59 to MTS.
  • Mapped Misc_60 to Tele2.
  • Mapped Misc_61 to Piastrix.

[3.0.0-rc.41] - 2020-06-09:

  • Mapped Misc_51 to MuchBetter.

[3.0.0-rc.40] - 2020-06-05:

  • Mapped Misc_50 to eZeeWallet.

[3.0.0-rc.39] - 2020-05-22:

  • Mapped Misc_48 to Paymero.
  • Mapped Misc_49 to Trustly.

[3.0.0-rc.38] - 2020-04-14:

  • Mapped Misc_47 to Neosurf.

[3.0.0-rc.37] - 2020-03-02:

  • Added Misc_51 to Misc_101 to alternative payment methods list.

[3.0.0-rc.36] - 2020-02-24:

  • Mapped Misc_46 to Zotapay.

[3.0.0-rc.35] - 2020-02-01:

  • Add amount simulation for Payout.
  • Remove DesiredResult from ExtraData for payout.

[3.0.0-rc.34] - 2020-01-29:

  • Mapped Misc_45 to CODVoucher.

[3.0.0-rc.33] - 2020-01-15:

  • Mapped Misc_43 to Finrax.
  • Mapped Misc_44 to Netbanking.

[3.0.0-rc.32] - 2019-11-20:

  • Add Misc_51 to Misc_101

[3.0.0-rc.31] - 2019-11-12:

  • Add Organization-Id header.

[3.0.0-rc.30] - 2019-11-04:

  • Remove Pagsmile-boleto.

[3.0.0-rc.29] - 2019-10-31:

  • Mapped Misc_37 to ToditoCash-card.
  • Mapped Misc_38 to cash-deposit.
  • Mapped Misc_39 to Pagsmile-deposit-express.
  • Mapped Misc_40 to Pagsmile-boleto.
  • Mapped Misc_41 to PayCash.
  • Mapped Misc_42 to Conekta-oxxo.

[3.0.0-rc.28] - 2019-10-10:

  • Mapped Misc_32 to ApplePay.
  • Mapped Misc_33 to GooglePay.
  • Mapped Misc_34 to LPG-payment-card.
  • Mapped Misc_35 to LPG-online.
  • Mapped Misc_36 to Pagsmile-lottery.

[3.0.0-rc.27] - 2019-10-02:

  • Updated Payout making GatewayAccountID optional

[3.0.0-rc.26] - 2019-09-13:

  • Mapped Misc_30 to Boleto.
  • Mapped Misc_31 to bank-transfer.
  • Mapped Misc_32 to voucher.

[3.0.0-rc.25] - 2019-09-11:

  • Added INOVAPAY payment methods descriptions

[3.0.0-rc.24] - 2019-08-23:

  • Add new magic card to simulate money out

[3.0.0-rc.23] - 2019-07-31:

  • Added Payout Status waiting-gateway
  • Added description about handling waiting-gateway status

[3.0.0-rc.22] - 2019-07-30:

  • Added Order Status waiting-gateway, refunded, voided, disputed, and partially-refunded

[3.0.0-rc.21] - 2019-07-19:

  • Added new methods of doing payouts, including payouts not mapped to inbound payments possible with a variety of methods:
    • Alternative methods that use a "generic" single financial account id
    • echeck
    • Interac Express Connect Direct Deposit
    • Interac e-Transfer out
    • SWIFT/DBT

[3.0.0-rc.20] - 2019-07-10:

  • Added Paysafecash for alternative method
  • Mapped Misc_29 to Paysafecash.

[3.0.0-rc.19] - 2019-06-05:

  • Mapped Misc_25 to Skrill.
  • Mapped Misc_26 to PayPal.
  • Mapped Misc_27 to Instant Banking.
  • Mapped Misc_28 to QIWI.

[3.0.0-rc.18] - 2019-05-31:

  • Added new methods PinPay, INOVAPAY-pin and INOVAPAY-wallet.
  • Mapped Misc_21 to PinPay.
  • Mapped Misc_23 to INOVAPAY-pin.
  • Mapped Misc_24 to INOVAPAY-wallet.

[3.0.0-rc.17] - 2019-05-31:

Added

  • Added new method Interac.

Changed

  • Mapped Misc_22 to Interac.

[3.0.0-rc.16] - 2019-04-04:

Fixed

  • Fixed format of the invalidFields in the error response.

[3.0.0-rc.15] - 2019-04-03:

Changed

  • Mapped Misc_30, Misc_40, and Misc_50to phone for testing purposes only. These are reserved to be modified in the future.

[3.0.0-rc.14] - 2019-04-01:

  • Added new methods Interac-online and Interac-eTransfer.
  • Mapped Misc_19 to Interac-online.
  • Mapped Misc_20 to Interac-eTransfer.

[3.0.0-rc.13] - 2019-03-21:

  • Added new methods CASHlib and Neteller.
  • Mapped Misc_17 to Neteller
  • Mapped Misc_18 to CASHlib

[3.0.0-rc.12] - 2019-03-18:

  • Added new methods ecoPayz and ecoVoucher.
  • Mapped Misc_15 to ecoVoucher
  • Mapped Misc_16 to ecoPayz

[3.0.0-rc.11] - 2019-03-13:

  • Added Misc_31 to Misc_50.
  • Mapped Misc_15 to Misc_50 to invoice

[3.0.0-rc.10] - 2019-03-11:

  • Added Misc_15 to Misc_30.
  • Fixed typo in: FinancialAccountId.
  • Added human message (read only) which can be displayed to a player: HumanMessage.

[3.0.0-rc.9] - 2019-02-26:

  • Added supported methods: Paysafecard.
  • Added miscellaneous mapped methods: Paysafecard.
  • Added supported methods: Onlineueberweisen.
  • Added miscellaneous mapped methods: Onlineueberweisen.

[3.0.0-rc.8] - 2019-02-21:

  • Added supported methods: SparkPay.
  • Added miscellaneous mapped methods: SparkPay.

[3.0.0-rc.7] - 2019-02-20:

  • Added supported methods: Pay4Fun.
  • Added miscellaneous mapped methods: Pay4Fun.

[3.0.0-rc.6] - 2019-02-12:

  • Add limit properties to enable preventing players from going over their preset limits by purchase adjustments.

[3.0.0-rc.5] - 2019-01-29:

  • Correct documentation that PhoneNumber is not a required field.

[3.0.0-rc.4] - 2018-09-06:

Added

  • Added missing documentation supported methods: Alipay, OchaPay, WeChat Pay, UPayCard, Flexepin, QQPay, Klarna, EPS, ePay.bg, iDEAL, domestic-cards, Skrill Rapid Transfer.
  • Added miscellaneous mapped methods.

[3.0.0-rc.3] - 2018-09-04:

Added

  • Added alternative method: Giropay.

[3.0.0-rc.2] - 2018-07-10

Added

  • Added links to use cases.
  • Added Payouts endpoint for money out.

[3.0.0-rc.1] - 2018-04-01

Changed

  • The API base URL changed from /mgs to /mgs-api.
  • The attribute State replaced with two new attributes Status and Result, clarifies the payment state.
  • The link approval_url renamed to approvalUrl.
  • The payment method become mandatory attribute.
  • The payment method payment_card renamed to payment-card.
  • The payment method wallet renamed to alternative-card. The attributes Wallet and WalletData are renamed to AlternativeMethod and PaymentData respectively.
  • The RedirectURLs is replaced with a single URL in attribute RedirectURL.
  • The state suspended is divided into two wating-approval and offiste.

Removed

  • Removed payment queue and endpoint /queue/payments/{paymentId}, thus server will not respond with the status 202 anymore. On suspended transaction it will respond with the status 201.

Errors

Rebilly follow's the error response format proposed in RFC 7807 also known as Problem Details for HTTP APIs. As with our normal API responses, your client must be prepared to gracefully handle additional members of the response.

Unauthorized

Unauthorized

Response Schema:
non-empty
type
string <uri>
Default: "https://mgs-api-docs.rebilly.com/index.html#section/Errors/Unauthorized"

URI reference [RFC3986] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".

Value: "https://mgs-api-docs.rebilly.com/index.html#section/Errors/Unauthorized"
status
integer [ 400 .. 599 ]
Default: 401

HTTP status code.

Value: 401
title
string
Default: "The request has not been applied because it lacks valid authentication credentials for the target resource."

Short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

Value: "The request has not been applied because it lacks valid authentication credentials for the target resource."
detail
string

Human-readable explanation specific to this occurrence of the problem.

property name*
additional property
any
{}

AccessForbidden

Access forbidden

Response Schema:
non-empty
type
string <uri>
Default: "https://mgs-api-docs.rebilly.com/index.html#section/Errors/AccessForbidden"

URI reference [RFC3986] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".

Value: "https://mgs-api-docs.rebilly.com/index.html#section/Errors/AccessForbidden"
status
integer [ 400 .. 599 ]
Default: 403

HTTP status code.

Value: 403
title
string
Default: "The server understood the request but refuses to authorize it."

Short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

Value: "The server understood the request but refuses to authorize it."
detail
string

Human-readable explanation specific to this occurrence of the problem.

property name*
additional property
any
{}

ResourceNotFound

Resource was not found

Response Schema:
non-empty
type
string <uri>
Default: "https://mgs-api-docs.rebilly.com/index.html#section/Errors/ResourceNotFound"

URI reference [RFC3986] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".

Value: "https://mgs-api-docs.rebilly.com/index.html#section/Errors/ResourceNotFound"
status
integer [ 400 .. 599 ]
Default: 404

HTTP status code.

Value: 404
title
string
Default: "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists."

Short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

Value: "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists."
detail
string

Human-readable explanation specific to this occurrence of the problem.

property name*
additional property
any
{}

Conflict

Conflict

Response Schema:
non-empty
type
string <uri>
Default: "https://mgs-api-docs.rebilly.com/index.html#section/Errors/Conflict"

URI reference [RFC3986] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".

Value: "https://mgs-api-docs.rebilly.com/index.html#section/Errors/Conflict"
status
integer [ 400 .. 599 ]
Default: 409

HTTP status code.

Value: 409
title
string
Default: "The request could not be completed due to a conflict with the current state of existing resources."

Short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

Value: "The request could not be completed due to a conflict with the current state of existing resources."
detail
string

Human-readable explanation specific to this occurrence of the problem.

property name*
additional property
any
{}

ValidationError

Invalid data was sent

Response Schema:
non-empty
type
string <uri>
Default: "https://mgs-api-docs.rebilly.com/index.html#section/Errors/ValidationError"

URI reference [RFC3986] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".

Value: "https://mgs-api-docs.rebilly.com/index.html#section/Errors/ValidationError"
status
integer [ 400 .. 599 ]
Default: 422

HTTP status code.

Value: 422
title
string
Default: "The request is invalid."

Short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

Value: "The request is invalid."
detail
string

Human-readable explanation specific to this occurrence of the problem.

Array of objects
property name*
additional property
any
{}

Authentication

When you sign up for an account, you are given your first API key. You can generate additional API keys, and delete API keys (as you may need to rotate your keys in the future). You authenticate to the Rebilly API by providing your secret key in the request header.

Rebilly offers multiple forms of authentication: secret key, JSON Web Tokens, and publishable key. We recommend private key authentication for this integration.

  • secret key: authenticates each request by searching for the presence of an HTTP header: REB-APIKEY.

Never share your secret keys. Keep them guarded and secure.

Environments

Rebilly has a sandbox and a live api. The primary differences are:

  • the same API Key will not work on both sandbox and live.
  • the sandbox is intended for testing.
  • the subdomain of the api endpoing is: api-sandbox in the sandbox, and api in the live environment.

Money-in Flow Diagram

Flow Diagram

Money-out Flow Diagram

Flow Diagram

Use Cases

See a collection of a use cases which may be valuable for understanding interaction with the API as well as for development and QA.

Miscellaneous Methods Mapping

Miscellaneous Method Mapped Method
Misc_1 domestic-cards
Misc_2 QQPay
Misc_3 Klarna
Misc_4 Skrill Rapid Transfer
Misc_5 EPS
Misc_6 ePay.bg
Misc_7 Giropay
Misc_8 CashToCode
Misc_9 iDebit
Misc_10 InstaDebit
Misc_11 Pay4Fun
Misc_12 SparkPay
Misc_13 Paysafecard
Misc_14 Onlineueberweisen
Misc_15 ecoVoucher
Misc_16 ecoPayz
Misc_17 Neteller
Misc_18 CASHlib
Misc_19 Interac-online
Misc_20 Interac-eTransfer
Misc_21 PinPay
Misc_22 Interac
Misc_23 INOVAPAY-pin
Misc_24 INOVAPAY-wallet
Misc_25 Skrill
Misc_26 PayPal
Misc_27 Instant Banking
Misc_28 QIWI
Misc_29 Paysafecash
Misc_30 Boleto
Misc_31 bank-transfer
Misc_32 ApplePay
Misc_33 GooglePay
Misc_34 LPG-payment-card
Misc_35 LPG-online
Misc_36 Pagsmile-lottery
Misc_37 ToditoCash-card
Misc_38 cash-deposit
Misc_39 Pagsmile-deposit-express
Misc_40 Phone
Misc_41 PayCash
Misc_42 Conekta-oxxo
Misc_43 Finrax
Misc_44 Netbanking
Misc_45 CODVoucher
Misc_46 Zotapay
Misc_47 Neosurf
Misc_48 Paymero
Misc_49 Trustly
Misc_50 eZeeWallet
Misc_51 MuchBetter
Misc_52 Yandex-money
Misc_53 Payeer
Misc_54 Perfect-money
Misc_55 Alfa-click
Misc_56 Terminaly-RF
Misc_57 Beeline
Misc_58 Megafon
Misc_59 MTS
Misc_60 Tele2
Misc_61 Piastrix
Misc_62 Webmoney
Misc_63 AdvCash
Misc_64 Khelocard
Misc_65 VCreditos
Misc_66 bank-transfer-2
Misc_67 bank-transfer-3
Misc_68 bank-transfer-4
Misc_69 bank-transfer-5
Misc_70 Bancontact
Misc_71 Belfius-direct-net
Misc_72 ING-homepay
Misc_73 Boleto-2
Misc_74 Boleto-3
Misc_75 Interac-eTransfer
Misc_76 TWINT
Misc_77 bank-transfer-6
Misc_78 bank-transfer-7
Misc_79 bank-transfer-8
Misc_80 voucher-2
Misc_81 voucher-3
Misc_82 voucher-4
Misc_83 Webpay-2
Misc_84 Webpay Card
Misc_85 Zimpler
Misc_86 bank-transfer-9
Misc_87 Airpay
Misc_88 PIX
Misc_89 Conekta-spei
Misc_90 Siirto
Misc_91 jpay
Misc_92 oriental-wallet
Misc_93 ezyEFT
Misc_94 Paymero-QR
Misc_95 bitcoin
Misc_96 Ethereum
Misc_97 Tether
Misc_98 picpay
Misc_99 Litecoin
Misc_100 UPI
Misc_101 bitcoin
Misc_102 Ethereum
Misc_103 Tether
Misc_104 Netbanking
Misc_105 PhonePe
Misc_106 PIX
Misc_107 AstroPay-GO
Misc_108 XPay-P2P
Misc_109 XPay-QR
Misc_110 loonie
Misc_111 PaymentAsia-crypto
Misc_112 MiFinity-eWallet
Misc_113 VenusPoint
Misc_114 iWallet
Misc_115 PostFinance-card
Misc_116 PostFinance-e-finance
Misc_117 Bancontact-mobile
Misc_118 Blik
Misc_119 P24
Misc_120 PayU
Misc_121 Sofort
Misc_122 online-bank-transfer
Misc_123 bank-transfer
Misc_124 Dimoco-pay-smart
Misc_125 voucher
Misc_126 bank-transfer
Misc_127 EPS
Misc_128 Paysafecard
Misc_129 POLi
Misc_130 rapyd-checkout
Misc_131 PagoEffectivo
Misc_132 iDEAL
Misc_133 Bizum
Misc_134 PIX
Misc_135 P24
Misc_136 bank-transfer
Misc_137 PIX
Misc_138 BankSEND
Misc_139 OXXO
Misc_140 Cleo
Misc_141 UPI
Misc_142 SafetyPay
Misc_143 InstantPayments
Misc_144 CashToCode
Misc_145 Klarna
Misc_146 KakaoPay
Misc_147 Payco
Misc_148 Samsung Pay
Misc_149 Wallet88
Misc_150 PIX
Misc_151 instant-bank-transfer
Misc_152 NordikCoin
Misc_153 USD-coin
Misc_154 VegaWallet
Misc_155 Tether
Misc_156 Tupay
Misc_157 Directa24Card
Misc_158 MercadoPago
Misc_159 EPS
Misc_160 Aircash
Misc_161 ePayCard
Misc_162 ePay.bg
Misc_163 cash-deposit
Misc_164 bank-transfer
Misc_165 invoice
Misc_166 invoice
Misc_167 invoice
Misc_168 invoice
Misc_169 invoice
Misc_170 phone
Misc_171 invoice
Misc_172 invoice
Misc_173 invoice
Misc_174 invoice
Misc_175 invoice
Misc_176 invoice
Misc_177 invoice
Misc_178 invoice
Misc_179 invoice
Misc_180 phone
Misc_181 invoice
Misc_182 invoice
Misc_183 invoice
Misc_184 invoice
Misc_185 invoice
Misc_186 invoice
Misc_187 invoice
Misc_188 invoice
Misc_189 invoice
Misc_190 phone
Misc_191 invoice
Misc_192 invoice
Misc_193 invoice
Misc_194 invoice
Misc_195 invoice
Misc_196 invoice
Misc_197 invoice
Misc_198 invoice
Misc_199 invoice
Misc_200 phone

Dynamic miscellaneous methods mapping - CashierMiscMethod

To map a miscellaneous method string to a payment method dynamically, follow these steps.

  1. Configure the payment method on a gateway account.
  2. Configure the CashierMiscMethod custom field on the gateway account to match the miscellaneous method string.
  3. When a transaction is created, the CashierMiscMethod custom field is used to map the miscellaneous method to the payment method.

This can be completed by the merchant in the Rebilly UI without assistance, and can also be used to re-use miscellaneous methods that are no longer required.

Only use CashierMiscMethod for Misc_165 and higher. Miscellaneous methods with numbers that are lower than 165 are static and do not change.

Note: Even though a gateway account contains the mapping from a miscellaneous method to a payment method, it does not mean that specific gateway account is necessarily used to process that transaction. The gateway account configuration is only a place to hold the mapping.

Example configuration

This example describes how to configure the bank-transfer payment method on the IpayOptions gateway account using CashierMiscMethod in the Rebilly UI.

When a POST /mgs/orders request is made with the miscellaneous method Misc_165, the payment method configured on the gateway account, bank-transfer will be assigned to the transaction.

  1. In the left navigation bar, click the Settings icon.
  2. In the Configuration section, click Gateway accounts.
  3. Click IpayOptions gateway. For more information, see Set up a payment gateway.
  4. In the right of the screen, Edit gateway.
  5. Configure the method as bank-transfer
  6. Scroll down to the Advanced configuration section, then turn on the Advanced configuration toggle.
  7. In the Custom fields section, in the CashierMiscMethod field, enter Misc_165.
  8. Click Save gateway account.

Supported payment methods

Rebilly has integrated over 60 payment methods. Here are some below.

Alipay

Key Facts Description
Alternative Method Name Alipay
Logos Download logo
Description Safely deposit using Alipay.
Geo Restrictions China
Allowed Currencies All.
Supports DCC Only forced DCC
Supports Refunds/PMOPS No
Test info Use RebillyProcessor with method "Alipay"
Display as a pop
UX The user will be redirected to a 3rd party hosted page, where the UX varies widely by bank and country (no standard)
FinancialAccountID Yes
PaymentData Response with any keys

AstroPay Card

A branded card.

Key Facts Description
Alternative Method Name AstroPay Card
Logos AstroPay Card logo
Description Deposit securely and privately using an AstroPay Card.
Geo Restrictions none
Allowed Currencies All
Supports DCC Only forced DCC
Supports Refunds/PMOPS No
Test info Use RebillyProcessor with method "AstroPay Card"
Display as a pop
UX The user will be redirected to a 3rd party hosted page where they will be presented with the AstroPay Card form in which they'll enter their AstroPay Card details and upon completion of which their AstroPay Card will be debited.
FinancialAccountID No
PaymentData These keys:
- code
- message
- response
- id_cashout
- auth_code

Bank Transfer

Key Facts Description
Alternative Method Name bank-transfer
Logos create generic bank transfer logos
Description Safely deposit funds into a bank account.
Geo Restrictions None
Allowed Currencies All.
Supports DCC Only forced DCC
Supports Refunds/PMOPS No
Test info Use RebillyProcessor with method "bank transfer"
Display as a pop
UX The user will be redirected to a 3rd party hosted page, where the UX varies widely by bank and country (no standard)
FinancialAccountID No
PaymentData Response with any keys

Bitcoin

Key Facts Description
Alternative Method Name bitcoin
Logos Use bitcoin logo
Description Deposit securely and privately using Bitcoin.
Geo Restrictions None
Allowed Currencies All.
Supports DCC Only forced DCC
Supports Refunds/PMOPS Yes, but no financial account id is returned, so it will be standalone and decoupled from deposits type of withdrawl method.
Test info Use RebillyProcessor with method "bitcoin"
Display as a pop
UX The user will be redirected to a 3rd party hosted page where they will complete their Bitcoin deposit, either by scanning a QR code and making the payment from their Bitcoin payment or by similar means.
FinancialAccountID No
PaymentData Response with any keys

Boleto

A Brazilian payment method.

Key Facts Description
Alternative Method Name Boleto
Logos Boleto logo
Description Pay using Boleto.
Geo Restrictions Brazil (only allowed)
Allowed Currencies All
Supports DCC Only forced DCC to Brazilian Real
Supports Refunds/PMOPS No
Test info Use RebillyProcessor with method "Boleto"
Display as a pop
UX The user will be redirected to a 3rd party hosted page where the player is presented with an on-screen Boleto slip, which they print or save and then use to pay in cash at a participating location such as a bank, or online using internet banking.
FinancialAccountID No
PaymentData These keys:
- code
- message
- response
- id_cashout
- auth_code

Cash

Deposit cash at participating outlets.

Key Facts Description
Alternative Method Name cash-deposit
Logos Generic cash logo
Description Deposit cash at participating outlets to top-up your casino account.
Geo Restrictions none
Allowed Currencies All
Supports DCC Only forced DCC
Supports Refunds/PMOPS No
Test info Use RebillyProcessor with method "Cash"
Display as a pop
UX The user will be redirected to a 3rd party hosted page where they will be presented with instructions on where and how to deposit cash. The user experience will differ based on the country and the cash outlet.
FinancialAccountID No
PaymentData Response with any keys

domestic-cards

Key Facts Description
Alternative Method Name domestic-cards
Logos generic logo
Description Instantly deposit using domestic-cards.
Geo Restrictions None
Allowed Currencies All
Supports DCC Only forced DCC
Supports Refunds/PMOPS No
Test info Use RebillyProcessor with method "domestic-cards"
Display as a pop
UX The user will be directed to a 3rd party hosted page, where they will be presented with a form to fill to complete the echeck transfer.
FinancialAccountID Yes
PaymentData Response with any keys

Echeck

Instantly pay using your nominated bank account.

Key Facts Description
Alternative Method Name echeck
Logos Use a standard echeck logo
Description Instantly pay using your nominated bank account.
Geo Restrictions Canada-only
Allowed Currencies All
Supports DCC Only forced DCC
Supports Refunds/PMOPS Sometimes depending on downstream processor -- if FinancialAccountID is present.
Test info Use RebillyProcessor with method "echeck"
Display as a pop
UX The user will be directed to a 3rd party hosted page, where they will be presented with a form to fill to complete the echeck transfer.
FinancialAccountID Sometimes (depending on downstream processor)
PaymentData Response with any keys

ePay.bg

ePay.bg alternative method.

Key Facts Description
Alternative Method Name ePay.bg
Logos Generic deposit logo
Description Deposit securely using ePay.bg.
Geo Restrictions None
Allowed Currencies All.
Supports DCC Only forced DCC
Supports Refunds/PMOPS No)
Test info Use RebillyProcessor with method "ePay.bg"
Display as a pop
UX The user will be redirected to a 3rd party hosted page where they will complete their deposit.
FinancialAccountID No
PaymentData Response with any keys

EPS

EPS alternative method.

Key Facts Description
Alternative Method Name EPS
Logos Generic deposit logo
Description Deposit securely using EPS.
Geo Restrictions None
Allowed Currencies All.
Supports DCC Only forced DCC
Supports Refunds/PMOPS No)
Test info Use RebillyProcessor with method "EPS"
Display as a pop
UX The user will be redirected to a 3rd party hosted page where they will complete their deposit.
FinancialAccountID No
PaymentData Response with any keys

Flexepin

Key Facts Description
Alternative Method Name Flexepin
Logos Download logos and images
Description Securely deposit using Flexepin.
Geo Restrictions None
Allowed Currencies All.
Supports DCC Only forced DCC
Supports Refunds/PMOPS No
Test info Use RebillyProcessor with method "Flexepin"
Display as a pop
UX The user will be redirected to a 3rd party hosted page, where the UX varies widely by bank and country (no standard).
FinancialAccountID No
PaymentData Response with any keys

Giropay

German Payment method

Key Facts Description
Alternative Method Name Giropay
Logos Download logos and images
Description Securely deposit using Giropay.
Geo Restrictions Only Germany
Allowed Currencies All. Only EUR is allowed by Skrill
Supports DCC Only forced DCC
Supports Refunds/PMOPS No
Test info Use RebillyProcessor with method "Giropay"
Display as a pop
UX The user will be redirected to a 3rd party hosted page, where the UX varies widely by bank and country (no standard).
FinancialAccountID No
PaymentData Response with any keys

Gpaysafe

Deposit directly from your bank account.

Key Facts Description
Alternative Method Name Gpaysafe
Logos Download logos and images
Description Deposit directly from your bank account.
Geo Restrictions Only TR, JP and NO are allowed
Allowed Currencies All. Only USD, EUR, CAD, GBP, JPY, TRY, PLN, DKK, AUD are allowed by Gpaysafe, but Rebilly will force DCC to one of those currencies, so all currencies may be allowed
Supports DCC Only forced DCC
Supports Refunds/PMOPS No (and no unique financial account id)
Test info Use RebillyProcessor with method "Gpaysafe"
Display as a pop
UX UX Flow Screenshots
FinancialAccountID No
PaymentData Gpaysafe will return a response with these keys:
- transactionId
- referenceNo
- date
- code
- message
- status
- acquirerReference
- amount
- currency

Hosted Payment Card

A hosted payment card form.

Key Facts Description
Alternative Method Name hosted-payment-card
Logos Use standard images of Visa and MC card brands.
Description Deposit with your credit or debit card.
Geo Restrictions No restrictions
Allowed Currencies All
Supports DCC Yes
Supports Refunds/PMOPS Yes
Test info Use RebillyProcessor with method "Payment Card"
Display as a pop
UX The user will be securely redirected to a 3rd party hosted page, where they will enter their card details in the conventional manner that online card payments work.
FinancialAccountID Yes
PaymentData (response is the same as for the payment-card method)

iDEAL

Key Facts Description
Alternative Method Name iDEAL
Logos generic logo
Description Instantly deposit using iDEAL.
Geo Restrictions None
Allowed Currencies All
Supports DCC Only forced DCC
Supports Refunds/PMOPS No
Test info Use RebillyProcessor with method "iDEAL"
Display as a pop
UX The user will be directed to a 3rd party hosted page, where they will be presented with a form to fill to complete the echeck transfer.
FinancialAccountID Yes
PaymentData Response with any keys

INOVAPAY-pin

Key Facts Description
Alternative Method Name INOVAPAY-pin
Logos generic logo
Description Uses 16 digit prepaid voucher with fixed amount.
Geo Restrictions Brazil
Allowed Currencies All. Only BRL is allowed by INOVAPAY, but it is possible to force DCC to this currency, so all currencies may be allowed
Supports DCC Only forced DCC
Supports Refunds/PMOPS No
Test info Use RebillyProcessor with method "INOVAPAY-pin"
Display as a pop
UX The user will be directed to a Rebilly hosted page, where they will be presented with a form to enter 16 digit pin.
FinancialAccountID No
PaymentData Response with any keys

INOVAPAY-wallet

Key Facts Description
Alternative Method Name INOVAPAY-wallet
Logos generic logo
Description Uses User ID and User Secure ID to perform payments.
Geo Restrictions Brazil
Allowed Currencies All. Only BRL is allowed by INOVAPAY, but it is possible to force DCC to this currency, so all currencies may be allowed
Supports DCC Only forced DCC
Supports Refunds/PMOPS No
Test info Use RebillyProcessor with method "INOVAPAY-wallet"
Display as a pop
UX The user will be directed to a Rebilly hosted page, where they will be presented with a form to enter INOVAPAY account data.
FinancialAccountID Yes
PaymentData Response with any keys

Instant Bank Transfer

Instantly deposit using online banking.

Key Facts Description
Alternative Method Name instant-bank-transfer
Logos create generic instant bank transfer logos
Description Instantly Deposit using online banking
Geo Restrictions None
Allowed Currencies All.
Supports DCC Only forced DCC
Supports Refunds/PMOPS No
Test info Use RebillyProcessor with method "bank transfer"
Display as a pop
UX The user will be redirected to a 3rd party hosted page, where the UX varies widely by bank and country (no standard)
FinancialAccountID No
PaymentData Response with any keys

Invoice

Pay an invoice using any means you feel comfortable.

Key Facts Description
Alternative Method Name invoice
Logos Generic invoice logo
Description Pay an invoice using any means you feel comfortable with for the amount you want to deposit in your account.
Geo Restrictions None
Allowed Currencies All.
Supports DCC Only forced DCC
Supports Refunds/PMOPS No
Test info Use RebillyProcessor with method "invoice"
Display as a pop
UX The user will be redirected to a 3rd party hosted page where they will be presented with an on-screen invoice and instructions on how to go about paying that invoice. This will vary widely from one invoice provider to another and from one country to another. Within a short period after the user paying hte invoice their account will be credited with the amount.
FinancialAccountID No
PaymentData Response with any keys

Jeton

Deposit instantly using your Jeton account.

Key Facts Description
Alternative Method Name Jeton
Logos Download logos and images
Description Deposit directly from your bank account.
Geo Restrictions Only TR, JP and NO are allowed
Allowed Currencies All. Only USD, EUR, GBP, JPY, TRY, PLN, DKK, AUD are allowed by Jeton, but Rebilly will force DCC to one of those currencies, so all currencies may be allowed
Supports DCC Only forced DCC
Supports Refunds/PMOPS Yes (using the receiverCustomerNumber which is the customerNumber in money in requests
Test info Use RebillyProcessor with method "Jeton"
Display as a pop
UX UX Flow Screenshots
FinancialAccountID Jeton uses their customerNumber as the FinancialAccountID
PaymentData Jeton will return a response with these keys:
- paymentId
- merchantOrderId
- customerNumber
- currencyCode
- amount
- status
- paymentJourneyStatus
- errorCode
- errorMessage

Klarna

Klarna alternative method.

Key Facts Description
Alternative Method Name Klarna
Logos Generic deposit logo
Description Deposit securely using Klarna.
Geo Restrictions None
Allowed Currencies All.
Supports DCC Only forced DCC
Supports Refunds/PMOPS No)
Test info Use RebillyProcessor with method "Klarna"
Display as a pop
UX The user will be redirected to a 3rd party hosted page where they will complete their deposit.
FinancialAccountID No
PaymentData Response with any keys

Miscellaneous

Miscellaneous alternative method.

Key Facts Description
Alternative Method Name miscellaneous
Logos Generic deposit logo
Description Deposit securely and instantly.
Geo Restrictions None
Allowed Currencies All.
Supports DCC Only forced DCC
Supports Refunds/PMOPS Sometimes (when FinancialAccountID is present)
Test info Use RebillyProcessor with method "miscellaneous"
Display as a pop
UX The user will be redirected to a 3rd party hosted page where they will complete their deposit.
FinancialAccountID Sometimes
PaymentData Response with any keys

OchaPay

Key Facts Description
Alternative Method Name OchaPay
Logos Download logos and images
Description Securely deposit using OchaPay.
Geo Restrictions None
Allowed Currencies All.
Supports DCC Only forced DCC
Supports Refunds/PMOPS No
Test info Use RebillyProcessor with method "OchaPay"
Display as a pop
UX The user will be redirected to a 3rd party hosted page, where the UX varies widely by bank and country (no standard).
FinancialAccountID No
PaymentData Response with any keys

Online Bank Transfer

Key Facts Description
Alternative Method Name online-bank-transfer
Logos create generic online bank transfer logos
Description Securely deposit using online bank transfer.
Geo Restrictions None
Allowed Currencies All.
Supports DCC Only forced DCC
Supports Refunds/PMOPS No
Test info Use RebillyProcessor with method "bank transfer"
Display as a pop
UX The user will be redirected to a 3rd party hosted page, where the UX varies widely by bank and country (no standard).
FinancialAccountID No
PaymentData Response with any keys

QQPay

Key Facts Description
Alternative Method Name QQPay
Logos generic QQPay logos
Description Safely deposit using QQPay.
Geo Restrictions China
Allowed Currencies All.
Supports DCC Only forced DCC
Supports Refunds/PMOPS No
Test info Use RebillyProcessor with method "QQPay"
Display as a pop
UX The user will be redirected to a 3rd party hosted page, where the UX varies widely by bank and country (no standard)
FinancialAccountID Yes
PaymentData Response with any keys

Phone

Key Facts Description
Alternative Method Name phone
Logos Create generic mobile phone payment logo.
Description Instantly Deposit using just your mobile phone.
Geo Restrictions None
Allowed Currencies All
Supports DCC Only forced DCC
Supports Refunds/PMOPS No (and no unique financial id)
Test info Use RebillyProcessor with method "Payment Card"
Display as a pop
UX UX Flow Screenshots
FinancialAccountID No
PaymentData Response with any keys

Skrill Rapid Transfer

Skrill Rapid Transfer alternative method.

Key Facts Description
Alternative Method Name Skrill Rapid Transfer
Logos Generic deposit logo
Description Deposit securely using Skrill Rapid Transfer.
Geo Restrictions None
Allowed Currencies All.
Supports DCC Only forced DCC
Supports Refunds/PMOPS No)
Test info Use RebillyProcessor with method "Skrill Rapid Transfer"
Display as a pop
UX The user will be redirected to a 3rd party hosted page where they will complete their deposit.
FinancialAccountID No
PaymentData Response with any keys

SMSVoucher

SMSVoucher by PayGround is a mobile-billing and invoicing solution for Norway and Sweden.

Key Facts Description
Alternative Method Name SMSVoucher
Logos Download logos and images
Description SMSVoucher is a mobile voucher solution that allows you to top-up your accounts through secure, friction free, online payment. By using SMSVoucher, the risk of having your identity and banking information exposed online is eliminated. This makes it safer than conventional online payment methods.
Geo Restrictions Only SE and NO are allowed
Allowed Currencies All. Only SEK, NOK and EUR are allowed by SMSVoucher, but Rebilly will force DCC to one of those currencies, so all currencies may be allowed
Supports DCC Only forced DCC
Supports Refunds/PMOPS No (only manually through PayGround support)
Test info Use RebillyProcessor with method "SMSVoucher". If needed, use voucher code: "1234567890"
Display as a pop
UX UX Flow Screenshots
FinancialAccountID SMSVoucher uses the mobile phone number as the identifier.
PaymentData SMSVoucher will return a response with these keys:
- ErrorMessage
- RejectionCode
- Success
- Amount
- ClientOrderId
- ClientTransactionId
- Currency
- MerchantId
- Mobile
- OrderId
- OrderStatus
- SecurePayStatus
- TransactionId

Voucher

Pre-purchase voucher participating retailers.

Key Facts Description
Alternative Method Name voucher
Logos Generic voucher logo
Description Pre-purchase a voucher at participating retailers using cash or card and redeem your voucher for real value chips at the casino.
Geo Restrictions none
Allowed Currencies All
Supports DCC Only forced DCC
Supports Refunds/PMOPS No
Test info Use RebillyProcessor with method "Voucher"
Display as a pop
UX The user will be redirected to a 3rd party hosted page where they will be presented with instructions on where and how to purhcase a voucher. The user experience will differ based on the country and the voucher distributor. The user will redeem the voucher. The deposit will be concluded.
FinancialAccountID No
PaymentData Response with any keys

UPayCard

Key Facts Description
Alternative Method Name UPayCard
Logos Download logos and images
Description Securely deposit using UPayCard.
Geo Restrictions None
Allowed Currencies All.
Supports DCC Only forced DCC
Supports Refunds/PMOPS No
Test info Use RebillyProcessor with method "UPayCard"
Display as a pop
UX The user will be redirected to a 3rd party hosted page, where the UX varies widely by bank and country (no standard).
FinancialAccountID Yes
PaymentData Response with any keys

WeChat Pay

Key Facts Description
Alternative Method Name WeChat Pay
Logos Download logo
Description Safely deposit using WeChat Pay.
Geo Restrictions China
Allowed Currencies All.
Supports DCC Only forced DCC
Supports Refunds/PMOPS No
Test info Use RebillyProcessor with method "WeChat Pay"
Display as a pop
UX The user will be redirected to a 3rd party hosted page, where the UX varies widely by bank and country (no standard)
FinancialAccountID Yes
PaymentData Response with any keys

Test Cards

Here is a list of test cards.

Test PAN Result Status Additional Description
4111111111111111 approved completed Visa
5555555555554444 approved completed MasterCard
378282246310005 approved completed American Express
6011111111111117 approved completed Discover
30569309025904 approved completed Diners Club
3530111333300000 approved completed JCB
4000000000000002 declined completed Visa
5105105105105100 declined completed MasterCard
371449635398431 declined completed American Express
6011000990139424 declined completed Discover
38520000023237 declined completed Diners Club
3566002020360505 declined completed JCB
4000000000000101 unknown waiting-approval (offsite) Simulate 3DS (Verified By Visa)
4000000000000200 unknown timeout n/a
4000000000001000 unknown conn-error Simulate processor connection exception

Payouts Test

Test Cards

All payout test cards will be approved for payments (orders). Payouts require use of the CardID which should be created with an approved request.

All that start in unknown due to some exception (like timeout, connection error, etc) will resolve in approximately 5 minutes in our test environment.

In production, it may take up to 24 hours to resolve a transaction's result (it will be resolved as soon as we are able to do so).

Test PAN Result Status Additional Description
4444333322221111 approved completed n/a
5454545454545454 declined completed n/a
4000020000000000 unknown --> approved timeout --> completed The payout will timeout first and have a timeout status and unknown result
4607000000000009 unknown --> declined timeout --> completed The payout will timeout first and have a timeout status and unknown result
4000180000000002 unknown --> declined conn-error --> completed The payout will have a connection-error first and have a conn-error status and unknown result
4000160000000004 unknown --> declined sending --> completed The payout will be stuck in a sending state first and then be declined
4400000000000008 unknown --> approved pending --> completed The payout will pending first and then be approved
4000640000000005 unknown --> approved waiting-gateway --> completed The payout will be waiting-gateway and then be approved

Test Amounts

All payouts can simulate the following outcomes by controlling the requested amount (regardless of currency).

Amount Result Status
<= 50 approved completed
> 50 AND <= 100 unknown timeout
> 100 AND <= 150 canceled conn-error
> 150 AND <= 200 unknown sending
> 200 AND <= 250 unknown pending
> 250 declined completed