PullFromCard
Pull funds from a card account.
Methods
POST
Perform a pullFromCard request.
Request
Copied!
{
"type": "object",
"properties": {
"instruction": {
"type": "object",
"properties": {
"narrative": {
"type": "object",
"properties": {
"line1": {
"type": "string"
},
"line2": {
"type": "string"
}
},
"required": [
"line1"
]
},
"recipient": {
"type": "object",
"properties": {
"fundReference": {
"type": "string"
},
"fundType": {
"type": "string"
}
},
"required": [
"fundReference",
"fundType"
]
},
"sender": {
"type": "object",
"properties": {
"authentication": {
"type": "object",
"properties": {
"authenticationValue": {
"type": "string"
},
"eci": {
"type": "string"
},
"transactionId": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"eci",
"type",
"version"
]
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"paymentInstrument": {
"oneOf": [
{
"type": "object",
"properties": {
"billingAddress": {
"type": "object",
"properties": {
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"address3": {
"type": "string"
},
"city": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"state": {
"type": "string"
}
},
"required": [
"countryCode",
"postalCode"
]
},
"cardExpiryDate": {
"type": "object",
"properties": {
"month": {
"type": "integer"
},
"year": {
"type": "integer"
}
},
"required": [
"month",
"year"
]
},
"cardHolderName": {
"type": "string"
},
"cardNumber": {
"type": "string"
},
"cvc": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"billingAddress",
"cardExpiryDate",
"cardHolderName",
"cardNumber",
"type"
]
},
{
"type": "object",
"properties": {
"billingAddress": {
"type": "object",
"properties": {
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"address3": {
"type": "string"
},
"city": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"state": {
"type": "string"
}
},
"required": [
"countryCode",
"postalCode"
]
},
"cvc": {
"type": "string"
},
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
}
]
}
},
"required": [
"paymentInstrument"
]
},
"value": {
"type": "object",
"properties": {
"amount": {
"type": "integer"
},
"currency": {
"type": "string"
}
},
"required": [
"amount",
"currency"
]
}
},
"required": [
"narrative",
"recipient",
"sender",
"value"
]
},
"merchant": {
"type": "object",
"properties": {
"entity": {
"type": "string"
}
},
"required": [
"entity"
]
},
"transactionReference": {
"type": "string"
}
},
"required": [
"instruction",
"merchant",
"transactionReference"
]
}{ "type": "object", "properties": { "instruction": { "type": "object", "properties": { "narrative": { "type": "object", "properties": { "line1": { "type": "string" }, "line2": { "type": "string" } }, "required": [ "line1" ] }, "recipient": { "type": "object", "properties": { "fundReference": { "type": "string" }, "fundType": { "type": "string" } }, "required": [ "fundReference", "fundType" ] }, "sender": { "type": "object", "properties": { "authentication": { "type": "object", "properties": { "authenticationValue": { "type": "string" }, "eci": { "type": "string" }, "transactionId": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } }, "required": [ "eci", "type", "version" ] }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "paymentInstrument": { "oneOf": [ { "type": "object", "properties": { "billingAddress": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "city": { "type": "string" }, "countryCode": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" } }, "required": [ "countryCode", "postalCode" ] }, "cardExpiryDate": { "type": "object", "properties": { "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "month", "year" ] }, "cardHolderName": { "type": "string" }, "cardNumber": { "type": "string" }, "cvc": { "type": "string" }, "type": { "type": "string" } }, "required": [ "billingAddress", "cardExpiryDate", "cardHolderName", "cardNumber", "type" ] }, { "type": "object", "properties": { "billingAddress": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "city": { "type": "string" }, "countryCode": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" } }, "required": [ "countryCode", "postalCode" ] }, "cvc": { "type": "string" }, "href": { "type": "string" }, "type": { "type": "string" } }, "required": [ "href", "type" ] } ] } }, "required": [ "paymentInstrument" ] }, "value": { "type": "object", "properties": { "amount": { "type": "integer" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] } }, "required": [ "narrative", "recipient", "sender", "value" ] }, "merchant": { "type": "object", "properties": { "entity": { "type": "string" } }, "required": [ "entity" ] }, "transactionReference": { "type": "string" } }, "required": [ "instruction", "merchant", "transactionReference" ] }
Responses
Response schema
Copied!
{
"type": "object",
"properties": {
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"templated": {
"type": "boolean"
}
},
"required": [
"href"
]
}
},
"required": [
"self"
]
},
"outcome": {
"type": "string"
},
"receivedAt": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"_links",
"outcome",
"receivedAt",
"type"
]
}{ "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string" }, "templated": { "type": "boolean" } }, "required": [ "href" ] } }, "required": [ "self" ] }, "outcome": { "type": "string" }, "receivedAt": { "type": "string" }, "type": { "type": "string" } }, "required": [ "_links", "outcome", "receivedAt", "type" ] }
Examples
A pullFromCard with all fields for a 'card/plain' paymentInstrument.
POSThttps://try.access.worldpay.com/moneyTransfers/pullFromCard
Copied!
{
"Authorization": "Basic Auth",
"Content-Type": "application/vnd.worldpay.money-transfers-v1+json",
"Accept": "application/vnd.worldpay.money-transfers-v1+json"
}{ "Authorization": "Basic Auth", "Content-Type": "application/vnd.worldpay.money-transfers-v1+json", "Accept": "application/vnd.worldpay.money-transfers-v1+json" }
Copied!
{
"transactionReference": "transactionReference",
"merchant": {
"entity": "default"
},
"instruction": {
"narrative": {
"line1": "line1",
"line2": "line2"
},
"value": {
"amount": 100,
"currency": "GBP"
},
"recipient": {
"fundReference": "fundReference",
"fundType": "nonStagedDigitalWallet"
},
"sender": {
"firstName": "firstName",
"lastName": "lastName",
"paymentInstrument": {
"type": "card/plain",
"cardHolderName": "name",
"cardNumber": "4444333322221111",
"cardExpiryDate": {
"month": 12,
"year": 2040
},
"cvc": "123",
"billingAddress": {
"address1": "address1",
"address2": "address2",
"address3": "address3",
"postalCode": "12345",
"city": "city",
"state": "state",
"countryCode": "GB"
}
}
}
}
}{ "transactionReference": "transactionReference", "merchant": { "entity": "default" }, "instruction": { "narrative": { "line1": "line1", "line2": "line2" }, "value": { "amount": 100, "currency": "GBP" }, "recipient": { "fundReference": "fundReference", "fundType": "nonStagedDigitalWallet" }, "sender": { "firstName": "firstName", "lastName": "lastName", "paymentInstrument": { "type": "card/plain", "cardHolderName": "name", "cardNumber": "4444333322221111", "cardExpiryDate": { "month": 12, "year": 2040 }, "cvc": "123", "billingAddress": { "address1": "address1", "address2": "address2", "address3": "address3", "postalCode": "12345", "city": "city", "state": "state", "countryCode": "GB" } } } } }
201
Copied!
{
"outcome": "approved",
"type": "pullFromCard",
"receivedAt": "2022-01-01T00:00:00Z",
"_links": {
"self": {
"href": "https://try.access.worldpay.com/moneyTransfers/{resource}"
}
}
}{ "outcome": "approved", "type": "pullFromCard", "receivedAt": "2022-01-01T00:00:00Z", "_links": { "self": { "href": "https://try.access.worldpay.com/moneyTransfers/{resource}" } } }
