Reference / @getenginex/sdk / RequestWithdrawalInput
RequestWithdrawalInput
RequestWithdrawalInput = {
amount:number;pixKeyId:string;pixKeyType?:never;pixKeyValue?:never; } | {amount:number;pixKeyId?:never;pixKeyType:"cpf";pixKeyValue?:string; } | {amount:number;pixKeyId?:never;pixKeyType:Exclude<PixKeyType,"cpf">;pixKeyValue:string; }
Withdrawal request: the amount and one way to indicate the destination PIX key — a saved key (pixKeyId, see PixKeysApi) or type + value given on the spot. With pixKeyType: 'cpf', pixKeyValue is optional: the gateway uses the CPF from the sign-up.
Union Members
Type Literal
{ amount: number; pixKeyId: string; pixKeyType?: never; pixKeyValue?: never; }
amount
amount:
number
Amount in minor units of the operator's currency.
pixKeyId
pixKeyId:
string
Id of a saved PIX key of the player.
pixKeyType?
optionalpixKeyType?:never
Do not use with pixKeyId.
pixKeyValue?
optionalpixKeyValue?:never
Do not use with pixKeyId.
Type Literal
{ amount: number; pixKeyId?: never; pixKeyType: "cpf"; pixKeyValue?: string; }
amount
amount:
number
Amount in minor units of the operator's currency.
pixKeyId?
optionalpixKeyId?:never
Do not use with pixKeyType.
pixKeyType
pixKeyType:
"cpf"
Key by the CPF from the sign-up.
pixKeyValue?
optionalpixKeyValue?:string
Optional: the gateway uses the CPF from the player's sign-up.
Type Literal
{ amount: number; pixKeyId?: never; pixKeyType: Exclude<PixKeyType, "cpf">; pixKeyValue: string; }
amount
amount:
number
Amount in minor units of the operator's currency.
pixKeyId?
optionalpixKeyId?:never
Do not use with pixKeyType.
pixKeyType
pixKeyType:
Exclude<PixKeyType,"cpf">
Key type.
pixKeyValue
pixKeyValue:
string
The key: email, phone or random key.