支出

向客户的卡发送资金。

标准支出

支出请求

向在您在查询验证根资源请求中收到的 payouts:basicDisbursement 操作链接发送请求，从而向您的客户进行支付。

注释：如果您想要支出到钱包，请首先阅读此处。

POST https://try.access.worldpay.com/payouts/basicDisbursement

支出请求正文：

Copied!

{
    "transactionReference": "Memory265-13/08/1876",
    "merchant": {
        "entity": "MindPalaceLtd"
    },
    "instruction": {
        "narrative": {
            "line1": "The Mind Palace Ltd",
            "line2": "Memory265-13/08/1876"
        },
        "value": {
            "currency": "GBP",
            "amount": 100
        },
        "payoutInstrument": {
            "type": "card/plain",
            "cardHolderName": "Sherlock Holmes",
            "cardNumber": "4444333322221111",
            "cardExpiryDate": {
                "month": 5,
                "year": 2035
            },
            "billingAddress": {
                "address1": "221B Baker Street",
                "address2": "Marylebone",
                "address3": "Westminster",
                "postalCode": "NW1 6XE",
                "city": "London",
                "state": "Greater London",
                "countryCode": "GB"
            }
        }
    }
}

{
    "transactionReference": "Memory265-13/08/1876",
    "merchant": {
        "entity": "MindPalaceLtd"
    },
    "instruction": {
        "narrative": {
            "line1": "The Mind Palace Ltd",
            "line2": "Memory265-13/08/1876"
        },
        "value": {
            "currency": "GBP",
            "amount": 100
        },
        "payoutInstrument": {
            "type": "card/tokenized",
            "href": "https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoiMjZ5OUp3Q2dEeDVjWEZBcjhjSmRlcmZTcE44ZzRoazFMcmNCSzlqaEVWcz0ifQ"
        }
    }
}

{
    "transactionReference": "Memory265-13/08/1876",
    "merchant": {
        "entity": "MindPalaceLtd"
    },
    "instruction": {
        "narrative": {
            "line1": "The Mind Palace Ltd",
            "line2": "Memory265-13/08/1876"
        },
        "value": {
            "currency": "GBP",
            "amount": 100
        },
        "payoutInstrument": {
            "type": "card/networkToken+applepay",
            "cardHolderName": "Sherlock Holmes",
            "dpan": "4444333322221111",
            "cardExpiryDate": {
                "month": 5,
                "year": 2035
            },
            "billingAddress": {
                "address1": "221B Baker Street",
                "address2": "Marylebone",
                "address3": "Westminster",
                "postalCode": "NW1 6XE",
                "city": "London",
                "state": "Greater London",
                "countryCode": "GB"
            }
        }
    }
}

支出请求参数的描述：

参数	必需	描述
`instruction`		包含与您的支出请求相关的所有信息的对象。
`instruction.payoutInstrument`		包含您的客户支出详情的对象。
`payoutInstrument.type`		包含您的客户支出类型的对象。可能的值： `card/plain` `card/tokenized` `card/networkToken+applepay`
`payoutInstrument.href`		包含指向访问 Token的链接的对象。对所有 `"type": "card/tokenized"` 请求为必需。
`payoutInstrument.dpan`		包含设备主账号的对象。对所有`"type": "card/networkToken+applepay"`请求为必需。
`value.amount`		支出金额。这是一个包含小数位的整数，e.g.，如果小数位是二，则 250 就表示 2.50.您可以在我们的货币表中查找相关小数位。
`value.currency`		3 位数货币代码。请参见支持的货币列表。
`instruction.narrative.line1`		出现在您的客户对账单上第一行中的文本。用于识别商户。请参见商户落款格式，了解更多详情和最佳实践。
`instruction.narrative.line2`		出现在您的客户对账单上第二行中的文本。用于提供有关商户的更多详情。请参见商户落款格式，了解更多详情和最佳实践。
`merchant`		包含有关商户信息的对象。
`merchant.entity`		这对于身份验证和查询为必需。请联系您的实施经理了解更多信息。
`transactionReference`		由您生成的独特参考号，用于在支出的整个生命周期中对其进行识别。请参见交易参考格式，了解更多详情和最佳实践。
`payoutInstrument.cardHolderName`		包含您的客户支出卡名称的对象。这不是必需字段，但建议您提供相关信息以提高授权率。如未发送，则默认值为 "Not Supplied"（未提供）。我们强烈建议您提供持卡人姓名，因为大多数发卡机构均要求提供。此外，这还会提升您的承兑率。
`payoutInstrument.cardExpiryDate`		包含您的客户支出卡过期日期的对象。对所有 `"type": "card/plain"` 请求为必需。可以是过去的某个日期，以便处理无参考号的退款。
`payoutInstrument.cardNumber`		包含您的客户支出卡号的对象。对 `"type": "card/plain"` 请求为必需。
`payoutInstrument.billingAddress`		包含账单邮寄地址信息的对象。如果包括在内，您至少须发送： `countryCode` `postalCode` 对于 Canadian Visa 卡的相关请求，必须提供银行卡的 `billingAddress` 详细资料。对于此类请求，您至少须发送： `address1` `city` `state` `countryCode` `postalCode` 您仅可通过 `card/plain` 或 `card/networkToken+applepay` 支付工具提供此类资料。我们建议您填写所有 Payout 请求的 `billingAddress` 字段。若 Visa 卡的 `basicDisbursement` 请求中未填写这些字段，可能会增加失败次数。其中包括默认为标准支付流程中的请求 `fastAccess`。您可在Visa OCT 授权条款中查找更多详情。

完整请求架构可在我们的API 参考中查阅。

支出响应

最佳实践：Access Worldpay 在服务响应的头文件中返回WP-correlationId。我们强烈建议您将此记录下来。我们使用WP-correlationId检查单个服务请求。

在您的响应中，我们会返回：

outcome，其中可能是：
- requestReceived - 我们已收到您的基本付款申请，并将在 3-5 个工作日内处理。
- refused - 该支出方法已被拒绝，请尝试使用另一张卡。
- error - 下游系统未能处理您的请求。
- queryRequired- 由于下游问题，目前无法确定您请求的结果。
时间戳 receivedAt
支出资源的地点

示例响应：

Copied!

{
    "outcome": "requestReceived",
    "receivedAt": "2023-09-06T12:29:39.625884Z",
    "_links": {
        "payouts:payout": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "curies": [{
            "name": "payouts",
            "href": "https://try.access.worldpay.com/rels/payouts/{rel}",
            "templated": true
        }]
    }
}

{
    "outcome": "refused",
    "receivedAt": "2023-09-06T12:29:39.625884Z",
    "_links": {
        "payouts:payout": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "curies": [{
            "name": "payouts",
            "href": "https://try.access.worldpay.com/rels/payouts/{rel}",
            "templated": true
        }]
    }
}

{
    "outcome": "error",
    "receivedAt": "2023-09-06T12:29:39.625884Z",
    "_links": {
        "payouts:payout": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "curies": [{
            "name": "payouts",
            "href": "https://try.access.worldpay.com/rels/payouts/{rel}",
            "templated": true
        }]
    }
}

{
    "outcome": "queryRequired",
    "receivedAt": "2018-09-01T10:37:36.923Z",
    "_links": {
        "payouts:payout": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "curies": [{
            "name": "payouts",
            "href": "https://try.access.worldpay.com/rels/payouts/{rel}",
            "templated": true
        }]
    }
}

最佳实践：我们建议使用事件服务，接收最新支付状态。

标准支出 `outcome`： `queryRequired`

向 payouts:payout 操作链接发送 GET 请求，以便检索您的支出请求的结果。当结果有更新时，payouts:update 操作链接会出现在 queryRequired 响应中。

示例响应：

GET https://try.access.worldpay.com/payouts/{resource}

Copied!

{
    "outcome": "queryRequired",
    "receivedAt": "2018-09-01T10:37:36.923Z",
    "_links": {
        "payouts:payout": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "payouts:update": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "curies": [{
            "name": "payouts",
            "href": "https://try.access.worldpay.com/rels/payouts/{rel}",
            "templated": true
        }]
    }
}

GET向 payouts:update 操作链接发送请求，以便查找结果的更新。

注释：如果没有更新，您会收到错误。您可以在我们的错误参考中了解进一步信息。

Fast Access

使用 Fast Access 可以在 30 分钟内向您的客户支付。

Fast Access 目前仅适用于通过 Visa Direct 进行的 Visa 支付。

前提条件：您必须先启用 Fast Access，然后才能使用它。请联系您的实施经理了解更多信息。

Fast Access 支出请求

将您的支出请求发送至您在查询支出根资源请求中收到的 payouts:fastAccess 操作链接。

如果您的客户卡启用了 Fast Access 功能，则会自动执行标准支出。

注释：如果您想要支出到钱包，请首先阅读此处。

POST https://try.access.worldpay.com/payouts/fastAccess

Fast Access 支出请求正文：

Copied!

{
    "transactionReference": "Memory265-13/08/1876",
    "merchant": {
        "entity": "MindPalaceLtd"
    },
    "instruction": {
        "narrative": {
            "line1": "The Mind Palace Ltd",
            "line2": "Memory265-13/08/1876"
        },
        "value": {
            "currency": "GBP",
            "amount": 100
        },
        "payoutInstrument": {
            "type": "card/plain",
            "cardHolderName": "Sherlock Holmes",
            "cardNumber": "4444333322221111",
            "cardExpiryDate": {
                "month": 5,
                "year": 2035
            },
            "billingAddress": {
                "address1": "221B Baker Street",
                "address2": "Marylebone",
                "address3": "Westminster",
                "postalCode": "NW1 6XE",
                "city": "London",
                "state": "Greater London",
                "countryCode": "GB"
            }
        }
    }
}

{
    "transactionReference": "Memory265-13/08/1876",
    "merchant": {
        "entity": "MindPalaceLtd"
    },
    "instruction": {
        "narrative": {
            "line1": "The Mind Palace Ltd",
            "line2": "Memory265-13/08/1876"
        },
        "value": {
            "currency": "GBP",
            "amount": 100
        },
        "payoutInstrument": {
            "type": "card/tokenized",
            "href": "https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoiMjZ5OUp3Q2dEeDVjWEZBcjhjSmRlcmZTcE44ZzRoazFMcmNCSzlqaEVWcz0ifQ"
        }
    }
}

{
    "transactionReference": "Memory265-13/08/1876",
    "merchant": {
        "entity": "MindPalaceLtd"
    },
    "instruction": {
        "narrative": {
            "line1": "The Mind Palace Ltd",
            "line2": "Memory265-13/08/1876"
        },
        "value": {
            "currency": "GBP",
            "amount": 100
        },
        "payoutInstrument": {
            "type": "card/networkToken+applepay",
            "cardHolderName": "Sherlock Holmes",
            "dpan": "4444333322221111",
            "cardExpiryDate": {
                "month": 5,
                "year": 2035
            },
            "billingAddress": {
                "address1": "221B Baker Street",
                "address2": "Marylebone",
                "address3": "Westminster",
                "postalCode": "NW1 6XE",
                "city": "London",
                "state": "Greater London",
                "countryCode": "GB"
            }
        }
    }
}

Fast Access 支出请求参数的描述

参数	必需	描述
`instruction`		包含与您的支出请求相关的所有信息的对象。
`payoutInstrument`		包含您的客户支出详情的对象。
`payoutInstrument.type`		包含您的客户支出类型的对象。可能的值： `card/plain` `card/tokenized` `card/networkToken+applepay`
`payoutInstrument.href`		包含指向访问 Token的链接的对象。对所有 `"type": "card/tokenized"` 请求为必需。
`payoutInstrument.dpan`		包含设备主账号的对象。对所有`"type": "card/networkToken+applepay"`请求为必需。
`value.amount`		支出金额。这是一个包含小数位的整数，e.g.，如果小数位是二，则 250 就表示 2.50.您可以在我们的货币表中查找相关小数位。
`value.currency`		3 位数货币代码。请参见支持的货币列表。
`instruction.narrative.line1`		出现在您的客户对账单上第一行中的文本。用于识别商户。请参见商户落款格式，了解更多详情和最佳实践。
`instruction.narrative.line2`		出现在您的客户对账单上第二行中的文本。用于提供有关商户的更多详情。请参见商户落款格式，了解更多详情和最佳实践。
`merchant`		包含有关商户信息的对象。
`merchant.entity`		这对于身份验证和查询为必需。请联系您的实施经理了解更多信息。
`transactionReference`		由您生成的独特参考号，用于在支出的整个生命周期中对其进行识别。请参见交易参考格式，了解更多详情和最佳实践。
`payoutInstrument.cardHolderName`		包含您的客户支出卡名称的对象。这不是必需字段，但建议您提供相关信息以提高授权率。如未提供，则默认值为 "Not Supplied"（未提供）。我们强烈建议您提供持卡人姓名，因为大多数发卡机构均要求提供。此外，这还会提升您的承兑率。
`payoutInstrument.cardExpiryDate`		包含您的客户支出卡过期日期的对象。对所有 `"type": "card/plain"` 请求为必需。必须是未来的日期。
`payoutInstrument.cardNumber`		包含您的客户支出卡号的对象。对所有 `"type": "card/plain"` 请求为必需。
`payoutInstrument.billingAddress`		包含账单邮寄地址信息的对象。如果包括在内，您至少须发送： `countryCode` `postalCode` 对于 Canadian Visa 卡的相关请求，必须提供银行卡的`billingAddress`详细资料。对于此类请求，您至少须发送： `address1` `city` `state` `countryCode` `postalCode` 您仅可通过 `card/plain` 或 `card/networkToken+applepay` 支付工具提供此类资料。我们建议您填写所有 Payout 请求的 `billingAddress` 字段。若 Visa 卡的 `basicDisbursement` 请求中未填写这些字段，可能会增加失败次数。其中包括默认为标准支付流程中的请求 `fastAccess`。您可在Visa OCT 授权条款中查找更多详情。

完整请求架构可在我们的API 参考中查阅。

Fast Access 支出响应

最佳实践：Access Worldpay 在服务响应的头文件中返回WP-CorrelationId。我们强烈建议您将此记录下来。我们使用WP-CorrelationId检查单个服务请求。

我们会在响应中返回：

outcome，其中可能是：
- requested- 我们已经收到了您的 Fast Access 付款。
- pending- 我们已将您的 Fast Access 付款请求发送至 Visa。如果在 48 小时内没有更新，则它会移至 error 结果。
- approved- Visa 已经批准了您的请求，如果发卡机构启用了 Fast Access ，则资金将在 30 分钟内拨付。否则，采用标准时间表。
- disbursed - 该交易利用 Visa 的每日报告进行对账。
- refused - 您的 Fast Access 付款请求已被拒绝。可能的拒绝原因：
  - 发卡机构拒绝了付款
  - Visa 拒绝了您的请求，因为发卡银行没有回应
  - 在请求的国家/地区不允许此类付款
- error - 在 48 小时内 Visa 没有响应，或 Visa 返回错误，确认请求已失败
- queryRequired- 由于下游问题，目前无法确定您请求的结果。
时间戳 receivedAt
支出资源的地点

Copied!

{
    "outcome": "requested",
    "receivedAt": "2023-09-06T12:29:39.625884Z",
    "_links": {
        "payouts:payout": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "curies": [{
            "name": "payouts",
            "href": "https://try.access.worldpay.com/rels/payouts/{rel}",
            "templated": true
        }]
    }
}

{
    "outcome": "pending",
    "receivedAt": "2023-09-06T12:29:39.625884Z",
    "_links": {
        "payouts:payout": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "curies": [{
            "name": "payouts",
            "href": "https://try.access.worldpay.com/rels/payouts/{rel}",
            "templated": true
        }]
    }
}

{
    "outcome": "approved",
    "receivedAt": "2023-09-06T12:29:39.625884Z",
    "_links": {
        "payouts:payout": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "curies": [{
            "name": "payouts",
            "href": "https://try.access.worldpay.com/rels/payouts/{rel}",
            "templated": true
        }]
    }
}

{
    "outcome": "disbursed",
    "receivedAt": "2023-09-06T12:29:39.625884Z",
    "_links": {
        "payouts:payout": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "curies": [{
            "name": "payouts",
            "href": "https://try.access.worldpay.com/rels/payouts/{rel}",
            "templated": true
        }]
    }
}

{
    "outcome": "refused",
    "receivedAt": "2023-09-06T12:29:39.625884Z",
    "_links": {
        "payouts:payout": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "curies": [{
            "name": "payouts",
            "href": "https://try.access.worldpay.com/rels/payouts/{rel}",
            "templated": true
        }]
    }
}

{
    "outcome": "error",
    "receivedAt": "2023-09-06T12:29:39.625884Z",
    "_links": {
        "payouts:payout": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "curies": [{
            "name": "payouts",
            "href": "https://try.access.worldpay.com/rels/payouts/{rel}",
            "templated": true
        }]
    }
}

{
    "outcome": "queryRequired",
    "receivedAt": "2018-09-01T10:37:36.923Z",
    "_links": {
        "payouts:payout": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "curies": [{
            "name": "payouts",
            "href": "https://try.access.worldpay.com/rels/payouts/{rel}",
            "templated": true
        }]
    }
}

`requested`、`pending`、`approved` 的 Fast Access 支出 `outcome` `queryRequired`

向 payouts:payout 操作链接发送 GET 请求，以便检索您的支出请求的结果。当结果有更新时，payouts:update 操作链接会出现在响应中。

示例：

GET https://try.access.worldpay.com/payouts/{resource}

示例响应：

Copied!

{
    "outcome": "requested",
    "receivedAt": "2023-09-06T12:29:39.625884Z",
    "_links": {
        "payouts:payout": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "payouts:update": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "curies": [{
            "name": "payouts",
            "href": "https://try.access.worldpay.com/rels/payouts/{rel}",
            "templated": true
        }]
    }
}

{
    "outcome": "pending",
    "receivedAt": "2023-09-06T12:29:39.625884Z",
    "_links": {
        "payouts:payout": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "payouts:update": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "curies": [{
            "name": "payouts",
            "href": "https://try.access.worldpay.com/rels/payouts/{rel}",
            "templated": true
        }]
    }
}

{
    "outcome": "approved",
    "receivedAt": "2023-09-06T12:29:39.625884Z",
    "_links": {
        "payouts:payout": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "payouts:update": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "curies": [{
            "name": "payouts",
            "href": "https://try.access.worldpay.com/rels/payouts/{rel}",
            "templated": true
        }]
    }
}

{
    "outcome": "queryRequired",
    "receivedAt": "2018-09-01T10:37:36.923Z",
    "_links": {
        "payouts:payout": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "payouts:update": {
            "href": "https://try.access.worldpay.com/payouts/{resource}"
        },
        "curies": [{
            "name": "payouts",
            "href": "https://try.access.worldpay.com/rels/payouts/{rel}",
            "templated": true
        }]
    }
}

GET向 payouts:update 操作链接发送请求，以便查找结果的更新。

注释：如果没有更新，您会收到错误。您可以在我们的错误参考中了解进一步信息。

使用原始资源检索支出

向在初始 basicDisbursement 或 fastAccess 请求的响应中返回的 payouts:payout 操作链接的资源发送 GET。

GET https://try.access.worldpay.com/payouts/{resource}

用您的初始响应中提供的地点替换上述链接中的 {resource}。

您只能从初始响应中获得地点。

在没有原始资源的情况下查询支出

如果现有支出的地点丢失，仍可以使用 payouts:query 端点来找回结果。

如要这么做，您必须拥有原始请求的 entity 和 transactionReference。

向 payouts:query 操作链接的资源发送 GET。

GET https://try.access.worldpay.com/payouts/query?transactionReference={transactionReference}&entity={entity}

用原始支出的 transactionReference 和 entity 替换上述链接中的 {transactionReference} 和 {entity}。

Translation disclaimer

支出

标准支出

支出请求

支出请求参数的描述：

支出响应

标准支出 `outcome`： `queryRequired`

Fast Access

Fast Access 支出请求

Fast Access 支出请求参数的描述

Fast Access 支出响应

`requested`、`pending`、`approved` 的 Fast Access 支出 `outcome` `queryRequired`

使用原始资源检索支出

在没有原始资源的情况下查询支出

Searching accross the entire site

Filter by product

Filter by product Searching across the entire site

Translation disclaimer Collapse

支出

标准支出

支出请求

支出请求参数的描述：

支出响应

标准支出 outcome： queryRequired

Fast Access

Fast Access 支出请求

Fast Access 支出请求参数的描述

Fast Access 支出响应

requested、pending、approved 的 Fast Access 支出 outcome queryRequired

使用原始资源检索支出

在没有原始资源的情况下查询支出

Searching accross the entire site

Filter by product

Filter by product Searching across the entire site

​

Translation disclaimer

标准支出 `outcome`： `queryRequired`

`requested`、`pending`、`approved` 的 Fast Access 支出 `outcome` `queryRequired`