UNPKG

@bebapps/rapyd-sdk

Version:

An un-official [Rapyd](https://rapyd.net) SDK for Node.js.

75 lines (74 loc) • 2.4 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
export interface CreatePayoutRequest { /** * String starting with **beneficiary_** or the object describing the beneficiary. */ beneficiary: `beneficiary_${string}`; /** * Country of the beneficiary. Two-letter ISO 3166-1 ALPHA-2 code. Uppercase. */ beneficiary_country?: string; /** * Type of entity for the beneficiary. One of the following: **individual**, **company** */ beneficiary_entity_type: string; /** * Determines whether completion of the payout requires confirmation of the FX rate. Relevant to payouts with foreign exchange. Default is false. */ confirm_automatically?: boolean; /** * Description of the payout transaction. */ description?: string; /** * Determines the time in which the payout must be completed, in [*Unix time*](ref:glossary). Relevant to cash payouts. */ expiration?: string; /** * ID of the wallet that the money is transferred from. String starting with **ewallet_**. */ ewallet?: `ewallet_${string}`; /** * ID defined by the client. Limited to 255 characters. */ merchant_reference_id?: string; /** * A JSON object defined by the client. */ metadata?: object; /** * Amount of the payout, in units of the currency defined in `payout_currency`. Mandatory when `sender_amount` is not used. Decimal. */ payout_amount?: number; /** * Currency received by the beneficiary. Three-letter ISO 4217 code. Uppercase. */ payout_currency: string; /** * The type of payout method. */ payout_method_type: string; /** * String starting with **sender_** or the object describing the sender. */ sender: `sender_${string}`; /** * Amount that the sender is paying in units of the currency defined in `sender_currency`. This amount remains the same regardless of FX fees. Required when `payout_amount` is not used. Decimal. */ sender_amount?: number; /** * Country of the sender. Two-letter ISO 3166-1 ALPHA-2 code. Uppercase. */ sender_country: string; /** * Currency that the sender is paying with. 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; /** * A statement that includes the reason for the payout. Limited to 35 characters. */ statement_descriptor?: string; };