@bebapps/rapyd-sdk
Version:
An un-official [Rapyd](https://rapyd.net) SDK for Node.js.
65 lines (63 loc) • 2.09 kB
text/typescript
import { BeneficiaryTokenizationPage } from '../types/BeneficiaryTokenizationPage';
export interface CreateBeneficiaryTokenizationPageRequest {
/**
* The two-letter ISO 3166-1 ALPHA-2 code for the beneficiary’s country.
*/
beneficiary_country?: string;
/**
* Type of entity for the beneficiary. One of the following: **individual**, **company**.
*/
beneficiary_entity_type: string;
/**
* Additional information about the beneficiary. See [Beneficiary Tokenization Page Object](ref:beneficiary-tokenization-page-object).
*/
beneficiary_optional_fields?: Partial<BeneficiaryTokenizationPage>;
/**
* URL where the customer is redirected when the hosted page is closed before the operation is complete.
*/
cancel_url?: string;
/**
* The category of payout method.
*/
category?: string;
/**
* URL where the customer is redirected when tokenization is successful.
*/
complete_url?: string;
/**
* Determines the default language of the hosted page.
*/
language?: string;
/**
* Identifier for the beneficiary. Defined by the client.
*/
merchant_reference_id?: string;
/**
* Date and time of the page expiration, in [*Unix time*](ref:glossary).
*/
page_expiration?: number;
/**
* Currency accepted by the beneficiary’s bank account. Three-letter ISO 4217 code. Uppercase.
*/
payout_currency?: string;
/**
* Array of strings. List of payout methods that are excluded from display on the beneficiary tokenization page.
*/
payout_method_types_exclude?: (string)[];
/**
* Array of strings. List of payout methods that are displayed on the beneficiary tokenization page.
*/
payout_method_types_include?: string;
/**
* The two-letter ISO 3166-1 ALPHA-2 code for the sender’s country.
*/
sender_country: string;
/**
* Currency paid from the sender’s wallet. Three-letter ISO 4217 code. Uppercase.
*/
sender_currency?: string;
/**
* Type of entity for the sender. One of the following: **individual**, **company**.
*/
sender_entity_type: string;
};